You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@solr.apache.org by sv...@apache.org on 2023/03/25 15:21:02 UTC
svn commit: r1082728 [21/33] - in /sites/solr/guide: ./ solr/9_0/ solr/9_0/configuration-guide/ solr/9_0/deployment-guide/ solr/9_0/getting-started/ solr/9_0/indexing-guide/ solr/9_0/query-guide/ solr/9_0/upgrade-notes/ solr/9_1/ solr/9_1/configuration...
Modified: sites/solr/guide/solr/latest/configuration-guide/update-request-processors.html
URL: http://svn.apache.org/viewvc/sites/solr/guide/solr/latest/configuration-guide/update-request-processors.html?rev=1082728&r1=1082727&r2=1082728&view=diff
==============================================================================
--- sites/solr/guide/solr/latest/configuration-guide/update-request-processors.html (original)
+++ sites/solr/guide/solr/latest/configuration-guide/update-request-processors.html Sat Mar 25 15:20:57 2023
@@ -39,7 +39,7 @@
<div class="navbar-item has-dropdown is-hoverable">
<a class="navbar-link" href="#">Resources</a>
<div class="navbar-dropdown">
- <a class="navbar-item" href="https://solr.apache.org/docs/9_1_1/index.html" target="_blank" rel="noreferrer nopener">Solr Javadocs</a>
+ <a class="navbar-item" href="https://solr.apache.org/docs/9_2_0/index.html" target="_blank" rel="noreferrer nopener">Solr Javadocs</a>
<a class="navbar-item" href="https://solr.apache.org/community.html#version-control" target="_blank" rel="noreferrer nopener">Source Code</a>
<a class="navbar-item" href="https://solr.apache.org/community.html" target="_blank" rel="noreferrer nopener">Community Links</a>
<a class="navbar-item" href="https://github.com/apache/solr/tree/main/dev-docs/ref-guide" target="_blank" rel="noreferrer nopener">Contribute</a>
@@ -56,25 +56,25 @@
</nav>
</header>
<div class="body">
-<div class="nav-container" data-component="solr" data-version="9_1">
+<div class="nav-container" data-component="solr" data-version="9_2">
<aside class="nav">
<div class="panels">
<!-- Solr Changes - Start -->
<div class="nav-panel-explore" data-panel="explore">
<div class="context">
<span class="title">Solr Reference Guide</span>
- <span class="version">9.1</span>
+ <span class="version">9.2</span>
</div>
<!-- Programmatically creates the component and version list -->
<ul class="components">
<li class="component is-current">
<a class="title" href="../index.html">Solr Reference Guide</a>
<ul class="versions">
- <li class="version">
- <a href="../../9_2/index.html">9.2-beta</a>
- </li>
<li class="version is-current is-latest">
- <a href="../index.html">9.1</a>
+ <a href="../index.html">9.2</a>
+ </li>
+ <li class="version">
+ <a href="../../9_1/index.html">9.1</a>
</li>
<li class="version">
<a href="../../9_0/index.html">9.0</a>
@@ -1040,6 +1040,13 @@
</li>
</ul>
</li>
+ <li class="nav-item" data-depth="0">
+<ul class="nav-list">
+ <li class="nav-item" data-depth="1">
+ <a class="nav-link" href="../how-to-contribute/how-to-contribute.html">How To Contribute</a>
+ </li>
+</ul>
+ </li>
</ul>
</nav>
</div>
@@ -1060,16 +1067,16 @@
</ul>
</nav>
<div class="page-versions">
- <button class="version-menu-toggle" title="Show other versions of page">9.1</button>
+ <button class="version-menu-toggle" title="Show other versions of page">9.2</button>
<div class="version-menu">
- <a class="version" href="../../9_2/configuration-guide/update-request-processors.html">9.2-beta</a>
- <a class="version is-current" href="update-request-processors.html">9.1</a>
+ <a class="version is-current" href="update-request-processors.html">9.2</a>
+ <a class="version" href="../../9_1/configuration-guide/update-request-processors.html">9.1</a>
<a class="version" href="../../9_0/configuration-guide/update-request-processors.html">9.0</a>
</div>
</div>
<!-- Solr Additions - Start -->
<!-- Solr New File -->
-<span class="perma-link-copy" version="9_1">
+<span class="perma-link-copy" version="9_2">
</span><!-- Solr Additions - End -->
<div class="edit-this-page"><a href="https://github.com/apache/solr/tree/main/solr/solr-ref-guide/modules/configuration-guide/pages/update-request-processors.adoc">Edit this Page</a></div>
</div>
@@ -1095,13 +1102,13 @@ In fact, a surprisingly large number of
<h2 id="urp-anatomy-and-lifecycle"><a class="anchor" href="#urp-anatomy-and-lifecycle"></a>URP Anatomy and Lifecycle</h2>
<div class="sectionbody">
<div class="paragraph">
-<p>An Update Request Processor is created as part of a <a href="https://solr.apache.org/docs/9_1_1/core/org/apache/solr/update/processor/UpdateRequestProcessorChain.html">chain</a> of one or more update processors.
+<p>An Update Request Processor is created as part of a <a href="https://solr.apache.org/docs/9_2_0/core/org/apache/solr/update/processor/UpdateRequestProcessorChain.html">chain</a> of one or more update processors.
Solr creates a default update request processor chain comprising of a few update request processors which enable essential Solr features.
This default chain is used to process every update request unless a user chooses to configure and specify a different custom update request processor chain.</p>
</div>
<div class="paragraph">
-<p>The easiest way to describe an Update Request Processor is to look at the Javadocs of the abstract class <a href="https://solr.apache.org/docs/9_1_1/core/org/apache/solr/update/processor/UpdateRequestProcessor.html">UpdateRequestProcessor</a>.
-Every UpdateRequestProcessor must have a corresponding factory class which extends <a href="https://solr.apache.org/docs/9_1_1/core/org/apache/solr/update/processor/UpdateRequestProcessorFactory.html">UpdateRequestProcessorFactory</a>.
+<p>The easiest way to describe an Update Request Processor is to look at the Javadocs of the abstract class <a href="https://solr.apache.org/docs/9_2_0/core/org/apache/solr/update/processor/UpdateRequestProcessor.html">UpdateRequestProcessor</a>.
+Every UpdateRequestProcessor must have a corresponding factory class which extends <a href="https://solr.apache.org/docs/9_2_0/core/org/apache/solr/update/processor/UpdateRequestProcessorFactory.html">UpdateRequestProcessorFactory</a>.
This factory class is used by Solr to create a new instance of this plugin.
Such a design provides two benefits:</p>
</div>
@@ -1123,7 +1130,7 @@ Each <code>UpdateRequestProcessorFactory
<div class="paragraph">
<p>When an update request is received by Solr, it looks up the update chain to be used for this request.
A new instance of each UpdateRequestProcessor specified in the chain is created using the corresponding factory.
-The update request is parsed into corresponding <a href="https://solr.apache.org/docs/9_1_1/core/org/apache/solr/update/UpdateCommand.html">UpdateCommand</a> objects which are run through the chain.
+The update request is parsed into corresponding <a href="https://solr.apache.org/docs/9_2_0/core/org/apache/solr/update/UpdateCommand.html">UpdateCommand</a> objects which are run through the chain.
Each UpdateRequestProcessor instance is responsible for invoking the next plugin in the chain.
It can choose to short circuit the chain by not invoking the next processor and even abort further processing by throwing an exception.</p>
</div>
@@ -1488,77 +1495,84 @@ You are strongly urged to examine the Ja
<h3 id="general-use-updateprocessorfactories"><a class="anchor" href="#general-use-updateprocessorfactories"></a>General Use UpdateProcessorFactories</h3>
<div class="dlist">
<dl>
-<dt class="hdlist1"><a href="https://solr.apache.org/docs/9_1_1/core/org/apache/solr/update/processor/AddSchemaFieldsUpdateProcessorFactory.html">AddSchemaFieldsUpdateProcessorFactory</a></dt>
+<dt class="hdlist1"><a href="https://solr.apache.org/docs/9_2_0/core/org/apache/solr/update/processor/AddSchemaFieldsUpdateProcessorFactory.html">AddSchemaFieldsUpdateProcessorFactory</a></dt>
<dd>
<p>This processor will dynamically add fields to the schema if an input document contains one or more fields that don’t match any field or dynamic field in the schema.</p>
</dd>
-<dt class="hdlist1"><a href="https://solr.apache.org/docs/9_1_1/core/org/apache/solr/update/processor/AtomicUpdateProcessorFactory.html">AtomicUpdateProcessorFactory</a></dt>
+<dt class="hdlist1"><a href="https://solr.apache.org/docs/9_2_0/core/org/apache/solr/update/processor/AtomicUpdateProcessorFactory.html">AtomicUpdateProcessorFactory</a></dt>
<dd>
<p>This processor will convert conventional field-value documents to atomic update documents.
This processor can be used at runtime (without defining it in <code>solrconfig.xml</code>), see the section <a href="#atomicupdateprocessorfactory">AtomicUpdateProcessorFactory</a> below.</p>
</dd>
-<dt class="hdlist1"><a href="https://solr.apache.org/docs/9_1_1/core/org/apache/solr/update/processor/ClassificationUpdateProcessorFactory.html">ClassificationUpdateProcessorFactory</a></dt>
+<dt class="hdlist1"><a href="https://solr.apache.org/docs/9_2_0/core/org/apache/solr/update/processor/ClassificationUpdateProcessorFactory.html">ClassificationUpdateProcessorFactory</a></dt>
<dd>
<p>This processor uses Lucene’s classification module to provide simple document classification.
See <a href="https://cwiki.apache.org/confluence/display/solr/SolrClassification" class="bare">https://cwiki.apache.org/confluence/display/solr/SolrClassification</a> for more details on how to use this processor.</p>
</dd>
-<dt class="hdlist1"><a href="https://solr.apache.org/docs/9_1_1/core/org/apache/solr/update/processor/CloneFieldUpdateProcessorFactory.html">CloneFieldUpdateProcessorFactory</a></dt>
+<dt class="hdlist1"><a href="https://solr.apache.org/docs/9_2_0/core/org/apache/solr/update/processor/CloneFieldUpdateProcessorFactory.html">CloneFieldUpdateProcessorFactory</a></dt>
<dd>
<p>Clones the values found in any matching <em>source</em> field into the configured <em>dest</em> field.</p>
</dd>
-<dt class="hdlist1"><a href="https://solr.apache.org/docs/9_1_1/core/org/apache/solr/update/processor/DefaultValueUpdateProcessorFactory.html">DefaultValueUpdateProcessorFactory</a></dt>
+<dt class="hdlist1"><a href="https://solr.apache.org/docs/9_2_0/core/org/apache/solr/update/processor/DefaultValueUpdateProcessorFactory.html">DefaultValueUpdateProcessorFactory</a></dt>
<dd>
<p>A simple processor that adds a default value to any document which does not already have a value in fieldName.</p>
</dd>
-<dt class="hdlist1"><a href="https://solr.apache.org/docs/9_1_1/core/org/apache/solr/update/processor/DocBasedVersionConstraintsProcessorFactory.html">DocBasedVersionConstraintsProcessorFactory</a></dt>
+<dt class="hdlist1"><a href="https://solr.apache.org/docs/9_2_0/core/org/apache/solr/update/processor/DocBasedVersionConstraintsProcessorFactory.html">DocBasedVersionConstraintsProcessorFactory</a></dt>
<dd>
<p>This Factory generates an UpdateProcessor that helps to enforce version constraints on documents based on per-document version numbers using a configured name of a versionField.</p>
</dd>
-<dt class="hdlist1"><a href="https://solr.apache.org/docs/9_1_1/core/org/apache/solr/update/processor/DocExpirationUpdateProcessorFactory.html">DocExpirationUpdateProcessorFactory</a></dt>
+<dt class="hdlist1"><a href="https://solr.apache.org/docs/9_2_0/core/org/apache/solr/update/processor/DocExpirationUpdateProcessorFactory.html">DocExpirationUpdateProcessorFactory</a></dt>
<dd>
<p>Update Processor Factory for managing automatic "expiration" of documents.</p>
</dd>
-<dt class="hdlist1"><a href="https://solr.apache.org/docs/9_1_1/core/org/apache/solr/update/processor/FieldNameMutatingUpdateProcessorFactory.html">FieldNameMutatingUpdateProcessorFactory</a></dt>
+<dt class="hdlist1"><a href="https://solr.apache.org/docs/9_2_0/core/org/apache/solr/update/processor/FieldNameMutatingUpdateProcessorFactory.html">FieldNameMutatingUpdateProcessorFactory</a></dt>
<dd>
<p>Modifies field names by replacing all matches to the configured <code>pattern</code> with the configured <code>replacement</code>.</p>
</dd>
-<dt class="hdlist1"><a href="https://solr.apache.org/docs/9_1_1/core/org/apache/solr/update/processor/IgnoreCommitOptimizeUpdateProcessorFactory.html">IgnoreCommitOptimizeUpdateProcessorFactory</a></dt>
+<dt class="hdlist1"><a href="https://solr.apache.org/docs/9_2_0/core/org/apache/solr/update/processor/IgnoreCommitOptimizeUpdateProcessorFactory.html">IgnoreCommitOptimizeUpdateProcessorFactory</a></dt>
<dd>
<p>Allows you to ignore commit and/or optimize requests from client applications when running in SolrCloud mode, for more information, see: Shards and Indexing Data in SolrCloud</p>
</dd>
-<dt class="hdlist1"><a href="https://solr.apache.org/docs/9_1_1/core/org/apache/solr/update/processor/IgnoreLargeDocumentProcessorFactory.html">IgnoreLargeDocumentProcessorFactory</a></dt>
+<dt class="hdlist1"><a href="https://solr.apache.org/docs/9_2_0/core/org/apache/solr/update/processor/IgnoreLargeDocumentProcessorFactory.html">IgnoreLargeDocumentProcessorFactory</a></dt>
<dd>
<p>Allows you to prevent large documents with size more than <code>limit</code> (in KB) from getting indexed.
It can help to prevent unexpected problems on indexing as well as on recovering because of very large documents.</p>
+<div class="paragraph">
+<p>By default, this processor will abort the update request and send an error back to users if it encounters a document that exceed its configured limit.
+Documents processed prior to the offender are indexed by Solr; documents following the offender are left unprocessed.</p>
+</div>
+<div class="paragraph">
+<p>Alternatively, the processor offers a "permissive" mode (<code>permissiveMode=true</code>) which skips the offending document and logs a warning, but doesn’t abort the remainder of the batch or return an error to users.</p>
+</div>
</dd>
-<dt class="hdlist1"><a href="https://solr.apache.org/docs/9_1_1/core/org/apache/solr/update/processor/RegexpBoostProcessorFactory.html">RegexpBoostProcessorFactory</a></dt>
+<dt class="hdlist1"><a href="https://solr.apache.org/docs/9_2_0/core/org/apache/solr/update/processor/RegexpBoostProcessorFactory.html">RegexpBoostProcessorFactory</a></dt>
<dd>
<p>A processor which will match content of "inputField" against regular expressions found in "boostFilename", and if it matches will return the corresponding boost value from the file and output this to "boostField" as a double value.</p>
</dd>
-<dt class="hdlist1"><a href="https://solr.apache.org/docs/9_1_1/core/org/apache/solr/update/processor/SignatureUpdateProcessorFactory.html">SignatureUpdateProcessorFactory</a></dt>
+<dt class="hdlist1"><a href="https://solr.apache.org/docs/9_2_0/core/org/apache/solr/update/processor/SignatureUpdateProcessorFactory.html">SignatureUpdateProcessorFactory</a></dt>
<dd>
<p>Uses a defined set of fields to generate a hash "signature" for the document.
Useful for only indexing one copy of "similar" documents.</p>
</dd>
-<dt class="hdlist1"><a href="https://solr.apache.org/docs/9_1_1/modules/scripting/org/apache/solr/scripting/update/ScriptUpdateProcessorFactory.html">ScriptUpdateProcessorFactory</a></dt>
+<dt class="hdlist1"><a href="https://solr.apache.org/docs/9_2_0/modules/scripting/org/apache/solr/scripting/update/ScriptUpdateProcessorFactory.html">ScriptUpdateProcessorFactory</a></dt>
<dd>
<p>A processor that enables the use of update processors implemented as scripts.
Learn more in the section <a href="script-update-processor.html" class="xref page">Script Update Processor</a>.</p>
</dd>
-<dt class="hdlist1"><a href="https://solr.apache.org/docs/9_1_1/core/org/apache/solr/update/processor/TemplateUpdateProcessorFactory.html">TemplateUpdateProcessorFactory</a></dt>
+<dt class="hdlist1"><a href="https://solr.apache.org/docs/9_2_0/core/org/apache/solr/update/processor/TemplateUpdateProcessorFactory.html">TemplateUpdateProcessorFactory</a></dt>
<dd>
<p>Allows adding new fields to documents based on a template pattern.
This update processor can also be used at runtime (without defining it in <code>solrconfig.xml</code>), see the section <a href="#templateupdateprocessorfactory">TemplateUpdateProcessorFactory</a> below.</p>
</dd>
-<dt class="hdlist1"><a href="https://solr.apache.org/docs/9_1_1/core/org/apache/solr/update/processor/TimestampUpdateProcessorFactory.html">TimestampUpdateProcessorFactory</a></dt>
+<dt class="hdlist1"><a href="https://solr.apache.org/docs/9_2_0/core/org/apache/solr/update/processor/TimestampUpdateProcessorFactory.html">TimestampUpdateProcessorFactory</a></dt>
<dd>
<p>An update processor that adds a newly generated date value of "NOW" to any document being added that does not already have a value in the specified field.</p>
</dd>
-<dt class="hdlist1"><a href="https://solr.apache.org/docs/9_1_1/core/org/apache/solr/update/processor/URLClassifyProcessorFactory.html">URLClassifyProcessorFactory</a></dt>
+<dt class="hdlist1"><a href="https://solr.apache.org/docs/9_2_0/core/org/apache/solr/update/processor/URLClassifyProcessorFactory.html">URLClassifyProcessorFactory</a></dt>
<dd>
<p>Update processor which examines a URL and outputs to various other fields with characteristics of that URL, including length, number of path levels, whether it is a top level URL (levels==0), whether it looks like a landing/index page, a canonical representation of the URL (e.g., stripping index.html), the domain and path parts of the URL, etc.</p>
</dd>
-<dt class="hdlist1"><a href="https://solr.apache.org/docs/9_1_1/core/org/apache/solr/update/processor/UUIDUpdateProcessorFactory.html">UUIDUpdateProcessorFactory</a></dt>
+<dt class="hdlist1"><a href="https://solr.apache.org/docs/9_2_0/core/org/apache/solr/update/processor/UUIDUpdateProcessorFactory.html">UUIDUpdateProcessorFactory</a></dt>
<dd>
<p>An update processor that adds a newly generated UUID value to any document being added that does not already have a value in the specified field.
This processor can also be used at runtime (without defining it in <code>solrconfig.xml</code>), see the section <a href="#uuidupdateprocessorfactory">UUIDUpdateProcessorFactory</a> below.</p>
@@ -1570,98 +1584,98 @@ This processor can also be used at runti
<h3 id="fieldmutatingupdateprocessorfactory-derived-factories"><a class="anchor" href="#fieldmutatingupdateprocessorfactory-derived-factories"></a>FieldMutatingUpdateProcessorFactory Derived Factories</h3>
<div class="paragraph">
<p>These factories all provide functionality to <em>modify</em> fields in a document as they’re being indexed.
-When using any of these factories, please consult the <a href="https://solr.apache.org/docs/9_1_1/core/org/apache/solr/update/processor/FieldMutatingUpdateProcessorFactory.html">FieldMutatingUpdateProcessorFactory javadocs</a> for details on the common options they all support for configuring which fields are modified.</p>
+When using any of these factories, please consult the <a href="https://solr.apache.org/docs/9_2_0/core/org/apache/solr/update/processor/FieldMutatingUpdateProcessorFactory.html">FieldMutatingUpdateProcessorFactory javadocs</a> for details on the common options they all support for configuring which fields are modified.</p>
</div>
<div class="dlist">
<dl>
-<dt class="hdlist1"><a href="https://solr.apache.org/docs/9_1_1/core/org/apache/solr/update/processor/ConcatFieldUpdateProcessorFactory.html">ConcatFieldUpdateProcessorFactory</a></dt>
+<dt class="hdlist1"><a href="https://solr.apache.org/docs/9_2_0/core/org/apache/solr/update/processor/ConcatFieldUpdateProcessorFactory.html">ConcatFieldUpdateProcessorFactory</a></dt>
<dd>
<p>Concatenates multiple values for fields matching the specified conditions using a configurable delimiter.</p>
</dd>
-<dt class="hdlist1"><a href="https://solr.apache.org/docs/9_1_1/core/org/apache/solr/update/processor/CountFieldValuesUpdateProcessorFactory.html">CountFieldValuesUpdateProcessorFactory</a></dt>
+<dt class="hdlist1"><a href="https://solr.apache.org/docs/9_2_0/core/org/apache/solr/update/processor/CountFieldValuesUpdateProcessorFactory.html">CountFieldValuesUpdateProcessorFactory</a></dt>
<dd>
<p>Replaces any list of values for a field matching the specified conditions with the count of the number of values for that field.</p>
</dd>
-<dt class="hdlist1"><a href="https://solr.apache.org/docs/9_1_1/core/org/apache/solr/update/processor/FieldLengthUpdateProcessorFactory.html">FieldLengthUpdateProcessorFactory</a></dt>
+<dt class="hdlist1"><a href="https://solr.apache.org/docs/9_2_0/core/org/apache/solr/update/processor/FieldLengthUpdateProcessorFactory.html">FieldLengthUpdateProcessorFactory</a></dt>
<dd>
<p>Replaces any CharSequence values found in fields matching the specified conditions with the lengths of those CharSequences (as an Integer).</p>
</dd>
-<dt class="hdlist1"><a href="https://solr.apache.org/docs/9_1_1/core/org/apache/solr/update/processor/FirstFieldValueUpdateProcessorFactory.html">FirstFieldValueUpdateProcessorFactory</a></dt>
+<dt class="hdlist1"><a href="https://solr.apache.org/docs/9_2_0/core/org/apache/solr/update/processor/FirstFieldValueUpdateProcessorFactory.html">FirstFieldValueUpdateProcessorFactory</a></dt>
<dd>
<p>Keeps only the first value of fields matching the specified conditions.</p>
</dd>
-<dt class="hdlist1"><a href="https://solr.apache.org/docs/9_1_1/core/org/apache/solr/update/processor/HTMLStripFieldUpdateProcessorFactory.html">HTMLStripFieldUpdateProcessorFactory</a></dt>
+<dt class="hdlist1"><a href="https://solr.apache.org/docs/9_2_0/core/org/apache/solr/update/processor/HTMLStripFieldUpdateProcessorFactory.html">HTMLStripFieldUpdateProcessorFactory</a></dt>
<dd>
<p>Strips all HTML Markup in any CharSequence values found in fields matching the specified conditions.</p>
</dd>
-<dt class="hdlist1"><a href="https://solr.apache.org/docs/9_1_1/core/org/apache/solr/update/processor/IgnoreFieldUpdateProcessorFactory.html">IgnoreFieldUpdateProcessorFactory</a></dt>
+<dt class="hdlist1"><a href="https://solr.apache.org/docs/9_2_0/core/org/apache/solr/update/processor/IgnoreFieldUpdateProcessorFactory.html">IgnoreFieldUpdateProcessorFactory</a></dt>
<dd>
<p>Ignores and removes fields matching the specified conditions from any document being added to the index.</p>
</dd>
-<dt class="hdlist1"><a href="https://solr.apache.org/docs/9_1_1/core/org/apache/solr/update/processor/LastFieldValueUpdateProcessorFactory.html">LastFieldValueUpdateProcessorFactory</a></dt>
+<dt class="hdlist1"><a href="https://solr.apache.org/docs/9_2_0/core/org/apache/solr/update/processor/LastFieldValueUpdateProcessorFactory.html">LastFieldValueUpdateProcessorFactory</a></dt>
<dd>
<p>Keeps only the last value of fields matching the specified conditions.</p>
</dd>
-<dt class="hdlist1"><a href="https://solr.apache.org/docs/9_1_1/core/org/apache/solr/update/processor/MaxFieldValueUpdateProcessorFactory.html">MaxFieldValueUpdateProcessorFactory</a></dt>
+<dt class="hdlist1"><a href="https://solr.apache.org/docs/9_2_0/core/org/apache/solr/update/processor/MaxFieldValueUpdateProcessorFactory.html">MaxFieldValueUpdateProcessorFactory</a></dt>
<dd>
<p>An update processor that keeps only the maximum value from any selected fields where multiple values are found.</p>
</dd>
-<dt class="hdlist1"><a href="https://solr.apache.org/docs/9_1_1/core/org/apache/solr/update/processor/MinFieldValueUpdateProcessorFactory.html">MinFieldValueUpdateProcessorFactory</a></dt>
+<dt class="hdlist1"><a href="https://solr.apache.org/docs/9_2_0/core/org/apache/solr/update/processor/MinFieldValueUpdateProcessorFactory.html">MinFieldValueUpdateProcessorFactory</a></dt>
<dd>
<p>An update processor that keeps only the minimum value from any selected fields where multiple values are found.</p>
</dd>
-<dt class="hdlist1"><a href="https://solr.apache.org/docs/9_1_1/core/org/apache/solr/update/processor/ParseBooleanFieldUpdateProcessorFactory.html">ParseBooleanFieldUpdateProcessorFactory</a></dt>
+<dt class="hdlist1"><a href="https://solr.apache.org/docs/9_2_0/core/org/apache/solr/update/processor/ParseBooleanFieldUpdateProcessorFactory.html">ParseBooleanFieldUpdateProcessorFactory</a></dt>
<dd>
<p>Attempts to mutate selected fields that have only CharSequence-typed values into Boolean values.</p>
</dd>
-<dt class="hdlist1"><a href="https://solr.apache.org/docs/9_1_1/core/org/apache/solr/update/processor/ParseDateFieldUpdateProcessorFactory.html">ParseDateFieldUpdateProcessorFactory</a></dt>
+<dt class="hdlist1"><a href="https://solr.apache.org/docs/9_2_0/core/org/apache/solr/update/processor/ParseDateFieldUpdateProcessorFactory.html">ParseDateFieldUpdateProcessorFactory</a></dt>
<dd>
<p>Attempts to mutate selected fields that have only CharSequence-typed values into Date values.</p>
</dd>
-<dt class="hdlist1"><a href="https://solr.apache.org/docs/9_1_1/core/org/apache/solr/update/processor/ParseNumericFieldUpdateProcessorFactory.html">ParseNumericFieldUpdateProcessorFactory</a> derived classes</dt>
+<dt class="hdlist1"><a href="https://solr.apache.org/docs/9_2_0/core/org/apache/solr/update/processor/ParseNumericFieldUpdateProcessorFactory.html">ParseNumericFieldUpdateProcessorFactory</a> derived classes</dt>
<dd>
<div class="dlist">
<dl>
-<dt class="hdlist1"><a href="https://solr.apache.org/docs/9_1_1/core/org/apache/solr/update/processor/ParseDoubleFieldUpdateProcessorFactory.html">ParseDoubleFieldUpdateProcessorFactory</a></dt>
+<dt class="hdlist1"><a href="https://solr.apache.org/docs/9_2_0/core/org/apache/solr/update/processor/ParseDoubleFieldUpdateProcessorFactory.html">ParseDoubleFieldUpdateProcessorFactory</a></dt>
<dd>
<p>Attempts to mutate selected fields that have only CharSequence-typed values into Double values.</p>
</dd>
-<dt class="hdlist1"><a href="https://solr.apache.org/docs/9_1_1/core/org/apache/solr/update/processor/ParseFloatFieldUpdateProcessorFactory.html">ParseFloatFieldUpdateProcessorFactory</a></dt>
+<dt class="hdlist1"><a href="https://solr.apache.org/docs/9_2_0/core/org/apache/solr/update/processor/ParseFloatFieldUpdateProcessorFactory.html">ParseFloatFieldUpdateProcessorFactory</a></dt>
<dd>
<p>Attempts to mutate selected fields that have only CharSequence-typed values into Float values.</p>
</dd>
-<dt class="hdlist1"><a href="https://solr.apache.org/docs/9_1_1/core/org/apache/solr/update/processor/ParseIntFieldUpdateProcessorFactory.html">ParseIntFieldUpdateProcessorFactory</a></dt>
+<dt class="hdlist1"><a href="https://solr.apache.org/docs/9_2_0/core/org/apache/solr/update/processor/ParseIntFieldUpdateProcessorFactory.html">ParseIntFieldUpdateProcessorFactory</a></dt>
<dd>
<p>Attempts to mutate selected fields that have only CharSequence-typed values into Integer values.</p>
</dd>
-<dt class="hdlist1"><a href="https://solr.apache.org/docs/9_1_1/core/org/apache/solr/update/processor/ParseLongFieldUpdateProcessorFactory.html">ParseLongFieldUpdateProcessorFactory</a></dt>
+<dt class="hdlist1"><a href="https://solr.apache.org/docs/9_2_0/core/org/apache/solr/update/processor/ParseLongFieldUpdateProcessorFactory.html">ParseLongFieldUpdateProcessorFactory</a></dt>
<dd>
<p>Attempts to mutate selected fields that have only CharSequence-typed values into Long values.</p>
</dd>
</dl>
</div>
</dd>
-<dt class="hdlist1"><a href="https://solr.apache.org/docs/9_1_1/core/org/apache/solr/update/processor/PreAnalyzedUpdateProcessorFactory.html">PreAnalyzedUpdateProcessorFactory</a></dt>
+<dt class="hdlist1"><a href="https://solr.apache.org/docs/9_2_0/core/org/apache/solr/update/processor/PreAnalyzedUpdateProcessorFactory.html">PreAnalyzedUpdateProcessorFactory</a></dt>
<dd>
<p>An update processor that parses configured fields of any document being added using <em>PreAnalyzedField</em> with the configured format parser.</p>
</dd>
-<dt class="hdlist1"><a href="https://solr.apache.org/docs/9_1_1/core/org/apache/solr/update/processor/RegexReplaceProcessorFactory.html">RegexReplaceProcessorFactory</a></dt>
+<dt class="hdlist1"><a href="https://solr.apache.org/docs/9_2_0/core/org/apache/solr/update/processor/RegexReplaceProcessorFactory.html">RegexReplaceProcessorFactory</a></dt>
<dd>
<p>An updated processor that applies a configured regex to any CharSequence values found in the selected fields, and replaces any matches with the configured replacement string.</p>
</dd>
-<dt class="hdlist1"><a href="https://solr.apache.org/docs/9_1_1/core/org/apache/solr/update/processor/RemoveBlankFieldUpdateProcessorFactory.html">RemoveBlankFieldUpdateProcessorFactory</a></dt>
+<dt class="hdlist1"><a href="https://solr.apache.org/docs/9_2_0/core/org/apache/solr/update/processor/RemoveBlankFieldUpdateProcessorFactory.html">RemoveBlankFieldUpdateProcessorFactory</a></dt>
<dd>
<p>Removes any values found which are CharSequence with a length of 0 (i.e., empty strings).</p>
</dd>
-<dt class="hdlist1"><a href="https://solr.apache.org/docs/9_1_1/core/org/apache/solr/update/processor/TrimFieldUpdateProcessorFactory.html">TrimFieldUpdateProcessorFactory</a></dt>
+<dt class="hdlist1"><a href="https://solr.apache.org/docs/9_2_0/core/org/apache/solr/update/processor/TrimFieldUpdateProcessorFactory.html">TrimFieldUpdateProcessorFactory</a></dt>
<dd>
<p>Trims leading and trailing whitespace from any CharSequence values found in fields matching the specified conditions.</p>
</dd>
-<dt class="hdlist1"><a href="https://solr.apache.org/docs/9_1_1/core/org/apache/solr/update/processor/TruncateFieldUpdateProcessorFactory.html">TruncateFieldUpdateProcessorFactory</a></dt>
+<dt class="hdlist1"><a href="https://solr.apache.org/docs/9_2_0/core/org/apache/solr/update/processor/TruncateFieldUpdateProcessorFactory.html">TruncateFieldUpdateProcessorFactory</a></dt>
<dd>
<p>Truncates any CharSequence values found in fields matching the specified conditions to a maximum character length.</p>
</dd>
-<dt class="hdlist1"><a href="https://solr.apache.org/docs/9_1_1/core/org/apache/solr/update/processor/UniqFieldsUpdateProcessorFactory.html">UniqFieldsUpdateProcessorFactory</a></dt>
+<dt class="hdlist1"><a href="https://solr.apache.org/docs/9_2_0/core/org/apache/solr/update/processor/UniqFieldsUpdateProcessorFactory.html">UniqFieldsUpdateProcessorFactory</a></dt>
<dd>
<p>Removes duplicate values found in fields matching the specified conditions.</p>
</dd>
@@ -1676,26 +1690,26 @@ See the README files associated with eac
</div>
<div class="dlist">
<dl>
-<dt class="hdlist1">The <a href="https://solr.apache.org/docs/9_1_1/modules/langid/index.html"><code>langid</code></a> module provides</dt>
+<dt class="hdlist1">The <a href="https://solr.apache.org/docs/9_2_0/modules/langid/index.html"><code>langid</code></a> module provides</dt>
<dd>
<div class="dlist">
<dl>
-<dt class="hdlist1"><a href="https://solr.apache.org/docs/9_1_1/modules/langid/org/apache/solr/update/processor/LangDetectLanguageIdentifierUpdateProcessorFactory.html">LangDetectLanguageIdentifierUpdateProcessorFactory</a></dt>
+<dt class="hdlist1"><a href="https://solr.apache.org/docs/9_2_0/modules/langid/org/apache/solr/update/processor/LangDetectLanguageIdentifierUpdateProcessorFactory.html">LangDetectLanguageIdentifierUpdateProcessorFactory</a></dt>
<dd>
<p>Identifies the language of a set of input fields using <a href="http://code.google.com/p/language-detection" class="bare">http://code.google.com/p/language-detection</a>.</p>
</dd>
-<dt class="hdlist1"><a href="https://solr.apache.org/docs/9_1_1/modules/langid/org/apache/solr/update/processor/TikaLanguageIdentifierUpdateProcessorFactory.html">TikaLanguageIdentifierUpdateProcessorFactory</a></dt>
+<dt class="hdlist1"><a href="https://solr.apache.org/docs/9_2_0/modules/langid/org/apache/solr/update/processor/TikaLanguageIdentifierUpdateProcessorFactory.html">TikaLanguageIdentifierUpdateProcessorFactory</a></dt>
<dd>
<p>Identifies the language of a set of input fields using Tika’s LanguageIdentifier.</p>
</dd>
</dl>
</div>
</dd>
-<dt class="hdlist1">The <a href="https://solr.apache.org/docs/9_1_1/modules/analysis-extras/index.html"><code>analysis-extras</code></a> module provides</dt>
+<dt class="hdlist1">The <a href="https://solr.apache.org/docs/9_2_0/modules/analysis-extras/index.html"><code>analysis-extras</code></a> module provides</dt>
<dd>
<div class="dlist">
<dl>
-<dt class="hdlist1"><a href="https://solr.apache.org/docs/9_1_1/modules/analysis-extras/org/apache/solr/update/processor/OpenNLPExtractNamedEntitiesUpdateProcessorFactory.html">OpenNLPExtractNamedEntitiesUpdateProcessorFactory</a></dt>
+<dt class="hdlist1"><a href="https://solr.apache.org/docs/9_2_0/modules/analysis-extras/org/apache/solr/update/processor/OpenNLPExtractNamedEntitiesUpdateProcessorFactory.html">OpenNLPExtractNamedEntitiesUpdateProcessorFactory</a></dt>
<dd>
<p>Update document(s) to be indexed with named entities extracted using an OpenNLP NER model.
Note that in order to use model files larger than 1MB on SolrCloud, you must either <a href="../deployment-guide/zookeeper-ensemble.html#increasing-the-file-size-limit" class="xref page">configure both ZooKeeper server and clients</a> or <a href="libs.html#lib-directives-in-solrconfig" class="xref page">store the model files on the filesystem</a> on each node hosting a collection replica.</p>
@@ -1714,12 +1728,12 @@ Other than insuring you do <em>not</em>
</div>
<div class="dlist">
<dl>
-<dt class="hdlist1"><a href="https://solr.apache.org/docs/9_1_1/core/org/apache/solr/update/processor/DistributedUpdateProcessorFactory.html">DistributedUpdateProcessorFactory</a></dt>
+<dt class="hdlist1"><a href="https://solr.apache.org/docs/9_2_0/core/org/apache/solr/update/processor/DistributedUpdateProcessorFactory.html">DistributedUpdateProcessorFactory</a></dt>
<dd>
<p>Used to distribute updates to all necessary nodes.</p>
<div class="dlist">
<dl>
-<dt class="hdlist1"><a href="https://solr.apache.org/docs/9_1_1/core/org/apache/solr/update/processor/NoOpDistributingUpdateProcessorFactory.html">NoOpDistributingUpdateProcessorFactory</a></dt>
+<dt class="hdlist1"><a href="https://solr.apache.org/docs/9_2_0/core/org/apache/solr/update/processor/NoOpDistributingUpdateProcessorFactory.html">NoOpDistributingUpdateProcessorFactory</a></dt>
<dd>
<p>An alternative No-Op implementation of <code>DistributingUpdateProcessorFactory</code> that always returns null.
Designed for experts who want to bypass distributed updates and use their own custom update logic.</p>
@@ -1727,12 +1741,12 @@ Designed for experts who want to bypass
</dl>
</div>
</dd>
-<dt class="hdlist1"><a href="https://solr.apache.org/docs/9_1_1/core/org/apache/solr/update/processor/LogUpdateProcessorFactory.html">LogUpdateProcessorFactory</a></dt>
+<dt class="hdlist1"><a href="https://solr.apache.org/docs/9_2_0/core/org/apache/solr/update/processor/LogUpdateProcessorFactory.html">LogUpdateProcessorFactory</a></dt>
<dd>
<p>A logging processor.
This keeps track of all commands that have passed through the chain and prints them on finish().</p>
</dd>
-<dt class="hdlist1"><a href="https://solr.apache.org/docs/9_1_1/core/org/apache/solr/update/processor/RunUpdateProcessorFactory.html">RunUpdateProcessorFactory</a></dt>
+<dt class="hdlist1"><a href="https://solr.apache.org/docs/9_2_0/core/org/apache/solr/update/processor/RunUpdateProcessorFactory.html">RunUpdateProcessorFactory</a></dt>
<dd>
<p>Executes the update commands using the underlying UpdateHandler.
Almost all processor chains should end with an instance of <code>RunUpdateProcessorFactory</code> unless the user is explicitly executing the update commands in an alternative custom <code>UpdateRequestProcessorFactory</code>.</p>
Modified: sites/solr/guide/solr/latest/configuration-guide/v2-api.html
URL: http://svn.apache.org/viewvc/sites/solr/guide/solr/latest/configuration-guide/v2-api.html?rev=1082728&r1=1082727&r2=1082728&view=diff
==============================================================================
--- sites/solr/guide/solr/latest/configuration-guide/v2-api.html (original)
+++ sites/solr/guide/solr/latest/configuration-guide/v2-api.html Sat Mar 25 15:20:57 2023
@@ -39,7 +39,7 @@
<div class="navbar-item has-dropdown is-hoverable">
<a class="navbar-link" href="#">Resources</a>
<div class="navbar-dropdown">
- <a class="navbar-item" href="https://solr.apache.org/docs/9_1_1/index.html" target="_blank" rel="noreferrer nopener">Solr Javadocs</a>
+ <a class="navbar-item" href="https://solr.apache.org/docs/9_2_0/index.html" target="_blank" rel="noreferrer nopener">Solr Javadocs</a>
<a class="navbar-item" href="https://solr.apache.org/community.html#version-control" target="_blank" rel="noreferrer nopener">Source Code</a>
<a class="navbar-item" href="https://solr.apache.org/community.html" target="_blank" rel="noreferrer nopener">Community Links</a>
<a class="navbar-item" href="https://github.com/apache/solr/tree/main/dev-docs/ref-guide" target="_blank" rel="noreferrer nopener">Contribute</a>
@@ -56,25 +56,25 @@
</nav>
</header>
<div class="body">
-<div class="nav-container" data-component="solr" data-version="9_1">
+<div class="nav-container" data-component="solr" data-version="9_2">
<aside class="nav">
<div class="panels">
<!-- Solr Changes - Start -->
<div class="nav-panel-explore" data-panel="explore">
<div class="context">
<span class="title">Solr Reference Guide</span>
- <span class="version">9.1</span>
+ <span class="version">9.2</span>
</div>
<!-- Programmatically creates the component and version list -->
<ul class="components">
<li class="component is-current">
<a class="title" href="../index.html">Solr Reference Guide</a>
<ul class="versions">
- <li class="version">
- <a href="../../9_2/index.html">9.2-beta</a>
- </li>
<li class="version is-current is-latest">
- <a href="../index.html">9.1</a>
+ <a href="../index.html">9.2</a>
+ </li>
+ <li class="version">
+ <a href="../../9_1/index.html">9.1</a>
</li>
<li class="version">
<a href="../../9_0/index.html">9.0</a>
@@ -1040,6 +1040,13 @@
</li>
</ul>
</li>
+ <li class="nav-item" data-depth="0">
+<ul class="nav-list">
+ <li class="nav-item" data-depth="1">
+ <a class="nav-link" href="../how-to-contribute/how-to-contribute.html">How To Contribute</a>
+ </li>
+</ul>
+ </li>
</ul>
</nav>
</div>
@@ -1060,16 +1067,16 @@
</ul>
</nav>
<div class="page-versions">
- <button class="version-menu-toggle" title="Show other versions of page">9.1</button>
+ <button class="version-menu-toggle" title="Show other versions of page">9.2</button>
<div class="version-menu">
- <a class="version" href="../../9_2/configuration-guide/v2-api.html">9.2-beta</a>
- <a class="version is-current" href="v2-api.html">9.1</a>
+ <a class="version is-current" href="v2-api.html">9.2</a>
+ <a class="version" href="../../9_1/configuration-guide/v2-api.html">9.1</a>
<a class="version" href="../../9_0/configuration-guide/v2-api.html">9.0</a>
</div>
</div>
<!-- Solr Additions - Start -->
<!-- Solr New File -->
-<span class="perma-link-copy" version="9_1">
+<span class="perma-link-copy" version="9_2">
</span><!-- Solr Additions - End -->
<div class="edit-this-page"><a href="https://github.com/apache/solr/tree/main/solr/solr-ref-guide/modules/configuration-guide/pages/v2-api.adoc">Edit this Page</a></div>
</div>
Modified: sites/solr/guide/solr/latest/deployment-guide/alias-management.html
URL: http://svn.apache.org/viewvc/sites/solr/guide/solr/latest/deployment-guide/alias-management.html?rev=1082728&r1=1082727&r2=1082728&view=diff
==============================================================================
--- sites/solr/guide/solr/latest/deployment-guide/alias-management.html (original)
+++ sites/solr/guide/solr/latest/deployment-guide/alias-management.html Sat Mar 25 15:20:57 2023
@@ -39,7 +39,7 @@
<div class="navbar-item has-dropdown is-hoverable">
<a class="navbar-link" href="#">Resources</a>
<div class="navbar-dropdown">
- <a class="navbar-item" href="https://solr.apache.org/docs/9_1_1/index.html" target="_blank" rel="noreferrer nopener">Solr Javadocs</a>
+ <a class="navbar-item" href="https://solr.apache.org/docs/9_2_0/index.html" target="_blank" rel="noreferrer nopener">Solr Javadocs</a>
<a class="navbar-item" href="https://solr.apache.org/community.html#version-control" target="_blank" rel="noreferrer nopener">Source Code</a>
<a class="navbar-item" href="https://solr.apache.org/community.html" target="_blank" rel="noreferrer nopener">Community Links</a>
<a class="navbar-item" href="https://github.com/apache/solr/tree/main/dev-docs/ref-guide" target="_blank" rel="noreferrer nopener">Contribute</a>
@@ -56,25 +56,25 @@
</nav>
</header>
<div class="body">
-<div class="nav-container" data-component="solr" data-version="9_1">
+<div class="nav-container" data-component="solr" data-version="9_2">
<aside class="nav">
<div class="panels">
<!-- Solr Changes - Start -->
<div class="nav-panel-explore" data-panel="explore">
<div class="context">
<span class="title">Solr Reference Guide</span>
- <span class="version">9.1</span>
+ <span class="version">9.2</span>
</div>
<!-- Programmatically creates the component and version list -->
<ul class="components">
<li class="component is-current">
<a class="title" href="../index.html">Solr Reference Guide</a>
<ul class="versions">
- <li class="version">
- <a href="../../9_2/index.html">9.2-beta</a>
- </li>
<li class="version is-current is-latest">
- <a href="../index.html">9.1</a>
+ <a href="../index.html">9.2</a>
+ </li>
+ <li class="version">
+ <a href="../../9_1/index.html">9.1</a>
</li>
<li class="version">
<a href="../../9_0/index.html">9.0</a>
@@ -1040,6 +1040,13 @@
</li>
</ul>
</li>
+ <li class="nav-item" data-depth="0">
+<ul class="nav-list">
+ <li class="nav-item" data-depth="1">
+ <a class="nav-link" href="../how-to-contribute/how-to-contribute.html">How To Contribute</a>
+ </li>
+</ul>
+ </li>
</ul>
</nav>
</div>
@@ -1062,16 +1069,16 @@
</ul>
</nav>
<div class="page-versions">
- <button class="version-menu-toggle" title="Show other versions of page">9.1</button>
+ <button class="version-menu-toggle" title="Show other versions of page">9.2</button>
<div class="version-menu">
- <a class="version" href="../../9_2/deployment-guide/alias-management.html">9.2-beta</a>
- <a class="version is-current" href="alias-management.html">9.1</a>
+ <a class="version is-current" href="alias-management.html">9.2</a>
+ <a class="version" href="../../9_1/deployment-guide/alias-management.html">9.1</a>
<a class="version" href="../../9_0/deployment-guide/alias-management.html">9.0</a>
</div>
</div>
<!-- Solr Additions - Start -->
<!-- Solr New File -->
-<span class="perma-link-copy" version="9_1">
+<span class="perma-link-copy" version="9_2">
</span><!-- Solr Additions - End -->
<div class="edit-this-page"><a href="https://github.com/apache/solr/tree/main/solr/solr-ref-guide/modules/deployment-guide/pages/alias-management.adoc">Edit this Page</a></div>
</div>
@@ -1855,7 +1862,7 @@ individual dimensions</p>
</div>
<div class="listingblock">
<div class="content">
-<pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">http://localhost:8982/solr/admin/collections?action=LISTALIASES</code></pre>
+<pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">curl -X GET 'http://localhost:8983/solr/admin/collections?action=LISTALIASES'</code></pre>
</div>
</div>
</div>
@@ -1867,15 +1874,27 @@ individual dimensions</p>
</div>
<div class="listingblock">
<div class="content">
-<pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">curl -X GET http://localhost:8983/api/cluster/aliases</code></pre>
+<pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">curl -X GET http://localhost:8983/api/aliases</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
+<div class="sect2">
+<h3 id="listaliases-getting-details-for-a-single-alias"><a class="anchor" href="#listaliases-getting-details-for-a-single-alias"></a>LISTALIASES Getting details for a single alias</h3>
+<div id="v2listsinglealias" class="exampleblock tab-pane">
+<div class="content">
<div class="paragraph">
-<p>The LISTALIASES action does not take any parameters.</p>
+<p><strong class="tab-label">V2 API only</strong></p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">curl -X GET http://localhost:8983/api/aliases/testalias2</code></pre>
+</div>
+</div>
+</div>
+</div>
</div>
<div class="sect2">
<h3 id="listaliases-response"><a class="anchor" href="#listaliases-response"></a>LISTALIASES Response</h3>
@@ -1885,15 +1904,47 @@ individual dimensions</p>
</div>
<div class="sect2">
<h3 id="examples-using-listaliases"><a class="anchor" href="#examples-using-listaliases"></a>Examples using LISTALIASES</h3>
+<div class="sect3">
+<h4 id="list-the-existing-aliases"><a class="anchor" href="#list-the-existing-aliases"></a>List the existing aliases</h4>
<div class="paragraph">
<p><strong>Input</strong></p>
</div>
+<div class="listingblock">
+<div class="content">
+<pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">curl -X GET http://localhost:8983/api/aliases</code></pre>
+</div>
+</div>
<div class="paragraph">
-<p>List the existing aliases, requesting information as XML from Solr:</p>
+<p><strong>Output</strong></p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre class="highlightjs highlight"><code class="language-json hljs" data-lang="json">{
+ "responseHeader": {
+ "status": 0,
+ "QTime": 1
+ },
+ "aliases": {
+ "testalias1": "collection1",
+ "testalias2": "collection2,collection1"
+ },
+ "properties": {
+ "testalias2": {
+ "someKey": "someValue"
+ }
+ }
+}</code></pre>
+</div>
+</div>
+</div>
+<div class="sect3">
+<h4 id="getting-details-for-a-single-alias"><a class="anchor" href="#getting-details-for-a-single-alias"></a>Getting details for a single alias</h4>
+<div class="paragraph">
+<p><strong>Input</strong></p>
</div>
<div class="listingblock">
<div class="content">
-<pre class="highlightjs highlight"><code class="language-text hljs" data-lang="text">http://localhost:8983/solr/admin/collections?action=LISTALIASES&wt=xml</code></pre>
+<pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">curl -X GET http://localhost:8983/api/aliases/testalias2</code></pre>
</div>
</div>
<div class="paragraph">
@@ -1901,22 +1952,21 @@ individual dimensions</p>
</div>
<div class="listingblock">
<div class="content">
-<pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><response>
- <lst name="responseHeader">
- <int name="status">0</int>
- <int name="QTime">0</int>
- </lst>
- <lst name="aliases">
- <str name="testalias1">collection1</str>
- <str name="testalias2">collection1,collection2</str>
- </lst>
- <lst name="properties">
- <lst name="testalias1"/>
- <lst name="testalias2">
- <str name="someKey">someValue</str>
- </lst>
- </lst>
-</response></code></pre>
+<pre class="highlightjs highlight"><code class="language-json hljs" data-lang="json">{
+ "responseHeader": {
+ "status": 0,
+ "QTime": 1
+ },
+ "name": "testalias2",
+ "collections": [
+ "collection2",
+ "collection1"
+ ],
+ "properties": {
+ "someKey": "someValue"
+ }
+}</code></pre>
+</div>
</div>
</div>
</div>
Modified: sites/solr/guide/solr/latest/deployment-guide/aliases.html
URL: http://svn.apache.org/viewvc/sites/solr/guide/solr/latest/deployment-guide/aliases.html?rev=1082728&r1=1082727&r2=1082728&view=diff
==============================================================================
--- sites/solr/guide/solr/latest/deployment-guide/aliases.html (original)
+++ sites/solr/guide/solr/latest/deployment-guide/aliases.html Sat Mar 25 15:20:57 2023
@@ -39,7 +39,7 @@
<div class="navbar-item has-dropdown is-hoverable">
<a class="navbar-link" href="#">Resources</a>
<div class="navbar-dropdown">
- <a class="navbar-item" href="https://solr.apache.org/docs/9_1_1/index.html" target="_blank" rel="noreferrer nopener">Solr Javadocs</a>
+ <a class="navbar-item" href="https://solr.apache.org/docs/9_2_0/index.html" target="_blank" rel="noreferrer nopener">Solr Javadocs</a>
<a class="navbar-item" href="https://solr.apache.org/community.html#version-control" target="_blank" rel="noreferrer nopener">Source Code</a>
<a class="navbar-item" href="https://solr.apache.org/community.html" target="_blank" rel="noreferrer nopener">Community Links</a>
<a class="navbar-item" href="https://github.com/apache/solr/tree/main/dev-docs/ref-guide" target="_blank" rel="noreferrer nopener">Contribute</a>
@@ -56,25 +56,25 @@
</nav>
</header>
<div class="body">
-<div class="nav-container" data-component="solr" data-version="9_1">
+<div class="nav-container" data-component="solr" data-version="9_2">
<aside class="nav">
<div class="panels">
<!-- Solr Changes - Start -->
<div class="nav-panel-explore" data-panel="explore">
<div class="context">
<span class="title">Solr Reference Guide</span>
- <span class="version">9.1</span>
+ <span class="version">9.2</span>
</div>
<!-- Programmatically creates the component and version list -->
<ul class="components">
<li class="component is-current">
<a class="title" href="../index.html">Solr Reference Guide</a>
<ul class="versions">
- <li class="version">
- <a href="../../9_2/index.html">9.2-beta</a>
- </li>
<li class="version is-current is-latest">
- <a href="../index.html">9.1</a>
+ <a href="../index.html">9.2</a>
+ </li>
+ <li class="version">
+ <a href="../../9_1/index.html">9.1</a>
</li>
<li class="version">
<a href="../../9_0/index.html">9.0</a>
@@ -1040,6 +1040,13 @@
</li>
</ul>
</li>
+ <li class="nav-item" data-depth="0">
+<ul class="nav-list">
+ <li class="nav-item" data-depth="1">
+ <a class="nav-link" href="../how-to-contribute/how-to-contribute.html">How To Contribute</a>
+ </li>
+</ul>
+ </li>
</ul>
</nav>
</div>
@@ -1061,16 +1068,16 @@
</ul>
</nav>
<div class="page-versions">
- <button class="version-menu-toggle" title="Show other versions of page">9.1</button>
+ <button class="version-menu-toggle" title="Show other versions of page">9.2</button>
<div class="version-menu">
- <a class="version" href="../../9_2/deployment-guide/aliases.html">9.2-beta</a>
- <a class="version is-current" href="aliases.html">9.1</a>
+ <a class="version is-current" href="aliases.html">9.2</a>
+ <a class="version" href="../../9_1/deployment-guide/aliases.html">9.1</a>
<a class="version" href="../../9_0/deployment-guide/aliases.html">9.0</a>
</div>
</div>
<!-- Solr Additions - Start -->
<!-- Solr New File -->
-<span class="perma-link-copy" version="9_1">
+<span class="perma-link-copy" version="9_2">
</span><!-- Solr Additions - End -->
<div class="edit-this-page"><a href="https://github.com/apache/solr/tree/main/solr/solr-ref-guide/modules/deployment-guide/pages/aliases.adoc">Edit this Page</a></div>
</div>
Modified: sites/solr/guide/solr/latest/deployment-guide/audit-logging.html
URL: http://svn.apache.org/viewvc/sites/solr/guide/solr/latest/deployment-guide/audit-logging.html?rev=1082728&r1=1082727&r2=1082728&view=diff
==============================================================================
--- sites/solr/guide/solr/latest/deployment-guide/audit-logging.html (original)
+++ sites/solr/guide/solr/latest/deployment-guide/audit-logging.html Sat Mar 25 15:20:57 2023
@@ -39,7 +39,7 @@
<div class="navbar-item has-dropdown is-hoverable">
<a class="navbar-link" href="#">Resources</a>
<div class="navbar-dropdown">
- <a class="navbar-item" href="https://solr.apache.org/docs/9_1_1/index.html" target="_blank" rel="noreferrer nopener">Solr Javadocs</a>
+ <a class="navbar-item" href="https://solr.apache.org/docs/9_2_0/index.html" target="_blank" rel="noreferrer nopener">Solr Javadocs</a>
<a class="navbar-item" href="https://solr.apache.org/community.html#version-control" target="_blank" rel="noreferrer nopener">Source Code</a>
<a class="navbar-item" href="https://solr.apache.org/community.html" target="_blank" rel="noreferrer nopener">Community Links</a>
<a class="navbar-item" href="https://github.com/apache/solr/tree/main/dev-docs/ref-guide" target="_blank" rel="noreferrer nopener">Contribute</a>
@@ -56,25 +56,25 @@
</nav>
</header>
<div class="body">
-<div class="nav-container" data-component="solr" data-version="9_1">
+<div class="nav-container" data-component="solr" data-version="9_2">
<aside class="nav">
<div class="panels">
<!-- Solr Changes - Start -->
<div class="nav-panel-explore" data-panel="explore">
<div class="context">
<span class="title">Solr Reference Guide</span>
- <span class="version">9.1</span>
+ <span class="version">9.2</span>
</div>
<!-- Programmatically creates the component and version list -->
<ul class="components">
<li class="component is-current">
<a class="title" href="../index.html">Solr Reference Guide</a>
<ul class="versions">
- <li class="version">
- <a href="../../9_2/index.html">9.2-beta</a>
- </li>
<li class="version is-current is-latest">
- <a href="../index.html">9.1</a>
+ <a href="../index.html">9.2</a>
+ </li>
+ <li class="version">
+ <a href="../../9_1/index.html">9.1</a>
</li>
<li class="version">
<a href="../../9_0/index.html">9.0</a>
@@ -1040,6 +1040,13 @@
</li>
</ul>
</li>
+ <li class="nav-item" data-depth="0">
+<ul class="nav-list">
+ <li class="nav-item" data-depth="1">
+ <a class="nav-link" href="../how-to-contribute/how-to-contribute.html">How To Contribute</a>
+ </li>
+</ul>
+ </li>
</ul>
</nav>
</div>
@@ -1060,16 +1067,16 @@
</ul>
</nav>
<div class="page-versions">
- <button class="version-menu-toggle" title="Show other versions of page">9.1</button>
+ <button class="version-menu-toggle" title="Show other versions of page">9.2</button>
<div class="version-menu">
- <a class="version" href="../../9_2/deployment-guide/audit-logging.html">9.2-beta</a>
- <a class="version is-current" href="audit-logging.html">9.1</a>
+ <a class="version is-current" href="audit-logging.html">9.2</a>
+ <a class="version" href="../../9_1/deployment-guide/audit-logging.html">9.1</a>
<a class="version" href="../../9_0/deployment-guide/audit-logging.html">9.0</a>
</div>
</div>
<!-- Solr Additions - Start -->
<!-- Solr New File -->
-<span class="perma-link-copy" version="9_1">
+<span class="perma-link-copy" version="9_2">
</span><!-- Solr Additions - End -->
<div class="edit-this-page"><a href="https://github.com/apache/solr/tree/main/solr/solr-ref-guide/modules/deployment-guide/pages/audit-logging.adoc">Edit this Page</a></div>
</div>
@@ -1446,7 +1453,7 @@ This will likely mostly be used in conju
</div>
<div class="paragraph">
<p>Note that logging to alternate destinations would need to be defined with a custom audit logging plugin.
-See the javadocs for the base class at <a href="https://solr.apache.org/docs/9_1_1/core/org/apache/solr/security/AuditLoggerPlugin.html">AuditLoggerPlugin</a>.</p>
+See the javadocs for the base class at <a href="https://solr.apache.org/docs/9_2_0/core/org/apache/solr/security/AuditLoggerPlugin.html">AuditLoggerPlugin</a>.</p>
</div>
</div>
</div>
Modified: sites/solr/guide/solr/latest/deployment-guide/authentication-and-authorization-plugins.html
URL: http://svn.apache.org/viewvc/sites/solr/guide/solr/latest/deployment-guide/authentication-and-authorization-plugins.html?rev=1082728&r1=1082727&r2=1082728&view=diff
==============================================================================
--- sites/solr/guide/solr/latest/deployment-guide/authentication-and-authorization-plugins.html (original)
+++ sites/solr/guide/solr/latest/deployment-guide/authentication-and-authorization-plugins.html Sat Mar 25 15:20:57 2023
@@ -39,7 +39,7 @@
<div class="navbar-item has-dropdown is-hoverable">
<a class="navbar-link" href="#">Resources</a>
<div class="navbar-dropdown">
- <a class="navbar-item" href="https://solr.apache.org/docs/9_1_1/index.html" target="_blank" rel="noreferrer nopener">Solr Javadocs</a>
+ <a class="navbar-item" href="https://solr.apache.org/docs/9_2_0/index.html" target="_blank" rel="noreferrer nopener">Solr Javadocs</a>
<a class="navbar-item" href="https://solr.apache.org/community.html#version-control" target="_blank" rel="noreferrer nopener">Source Code</a>
<a class="navbar-item" href="https://solr.apache.org/community.html" target="_blank" rel="noreferrer nopener">Community Links</a>
<a class="navbar-item" href="https://github.com/apache/solr/tree/main/dev-docs/ref-guide" target="_blank" rel="noreferrer nopener">Contribute</a>
@@ -56,25 +56,25 @@
</nav>
</header>
<div class="body">
-<div class="nav-container" data-component="solr" data-version="9_1">
+<div class="nav-container" data-component="solr" data-version="9_2">
<aside class="nav">
<div class="panels">
<!-- Solr Changes - Start -->
<div class="nav-panel-explore" data-panel="explore">
<div class="context">
<span class="title">Solr Reference Guide</span>
- <span class="version">9.1</span>
+ <span class="version">9.2</span>
</div>
<!-- Programmatically creates the component and version list -->
<ul class="components">
<li class="component is-current">
<a class="title" href="../index.html">Solr Reference Guide</a>
<ul class="versions">
- <li class="version">
- <a href="../../9_2/index.html">9.2-beta</a>
- </li>
<li class="version is-current is-latest">
- <a href="../index.html">9.1</a>
+ <a href="../index.html">9.2</a>
+ </li>
+ <li class="version">
+ <a href="../../9_1/index.html">9.1</a>
</li>
<li class="version">
<a href="../../9_0/index.html">9.0</a>
@@ -1040,6 +1040,13 @@
</li>
</ul>
</li>
+ <li class="nav-item" data-depth="0">
+<ul class="nav-list">
+ <li class="nav-item" data-depth="1">
+ <a class="nav-link" href="../how-to-contribute/how-to-contribute.html">How To Contribute</a>
+ </li>
+</ul>
+ </li>
</ul>
</nav>
</div>
@@ -1060,16 +1067,16 @@
</ul>
</nav>
<div class="page-versions">
- <button class="version-menu-toggle" title="Show other versions of page">9.1</button>
+ <button class="version-menu-toggle" title="Show other versions of page">9.2</button>
<div class="version-menu">
- <a class="version" href="../../9_2/deployment-guide/authentication-and-authorization-plugins.html">9.2-beta</a>
- <a class="version is-current" href="authentication-and-authorization-plugins.html">9.1</a>
+ <a class="version is-current" href="authentication-and-authorization-plugins.html">9.2</a>
+ <a class="version" href="../../9_1/deployment-guide/authentication-and-authorization-plugins.html">9.1</a>
<a class="version" href="../../9_0/deployment-guide/authentication-and-authorization-plugins.html">9.0</a>
</div>
</div>
<!-- Solr Additions - Start -->
<!-- Solr New File -->
-<span class="perma-link-copy" version="9_1">
+<span class="perma-link-copy" version="9_2">
</span><!-- Solr Additions - End -->
<div class="edit-this-page"><a href="https://github.com/apache/solr/tree/main/solr/solr-ref-guide/modules/deployment-guide/pages/authentication-and-authorization-plugins.adoc">Edit this Page</a></div>
</div>
@@ -1295,7 +1302,7 @@ A custom plugin can be implemented by ex
<h2 id="configuring-authorization"><a class="anchor" href="#configuring-authorization"></a>Authorization</h2>
<div class="sectionbody">
<div class="paragraph">
-<p>An authorization plugin can be written for Solr by extending the <a href="https://solr.apache.org/docs/9_1_1/core/org/apache/solr/security/AuthorizationPlugin.html">AuthorizationPlugin</a> interface.</p>
+<p>An authorization plugin can be written for Solr by extending the <a href="https://solr.apache.org/docs/9_2_0/core/org/apache/solr/security/AuthorizationPlugin.html">AuthorizationPlugin</a> interface.</p>
</div>
<div class="sect2">
<h3 id="enabling-an-authorization-plugin"><a class="anchor" href="#enabling-an-authorization-plugin"></a>Enabling an Authorization Plugin</h3>
Modified: sites/solr/guide/solr/latest/deployment-guide/backup-restore.html
URL: http://svn.apache.org/viewvc/sites/solr/guide/solr/latest/deployment-guide/backup-restore.html?rev=1082728&r1=1082727&r2=1082728&view=diff
==============================================================================
--- sites/solr/guide/solr/latest/deployment-guide/backup-restore.html (original)
+++ sites/solr/guide/solr/latest/deployment-guide/backup-restore.html Sat Mar 25 15:20:57 2023
@@ -39,7 +39,7 @@
<div class="navbar-item has-dropdown is-hoverable">
<a class="navbar-link" href="#">Resources</a>
<div class="navbar-dropdown">
- <a class="navbar-item" href="https://solr.apache.org/docs/9_1_1/index.html" target="_blank" rel="noreferrer nopener">Solr Javadocs</a>
+ <a class="navbar-item" href="https://solr.apache.org/docs/9_2_0/index.html" target="_blank" rel="noreferrer nopener">Solr Javadocs</a>
<a class="navbar-item" href="https://solr.apache.org/community.html#version-control" target="_blank" rel="noreferrer nopener">Source Code</a>
<a class="navbar-item" href="https://solr.apache.org/community.html" target="_blank" rel="noreferrer nopener">Community Links</a>
<a class="navbar-item" href="https://github.com/apache/solr/tree/main/dev-docs/ref-guide" target="_blank" rel="noreferrer nopener">Contribute</a>
@@ -56,25 +56,25 @@
</nav>
</header>
<div class="body">
-<div class="nav-container" data-component="solr" data-version="9_1">
+<div class="nav-container" data-component="solr" data-version="9_2">
<aside class="nav">
<div class="panels">
<!-- Solr Changes - Start -->
<div class="nav-panel-explore" data-panel="explore">
<div class="context">
<span class="title">Solr Reference Guide</span>
- <span class="version">9.1</span>
+ <span class="version">9.2</span>
</div>
<!-- Programmatically creates the component and version list -->
<ul class="components">
<li class="component is-current">
<a class="title" href="../index.html">Solr Reference Guide</a>
<ul class="versions">
- <li class="version">
- <a href="../../9_2/index.html">9.2-beta</a>
- </li>
<li class="version is-current is-latest">
- <a href="../index.html">9.1</a>
+ <a href="../index.html">9.2</a>
+ </li>
+ <li class="version">
+ <a href="../../9_1/index.html">9.1</a>
</li>
<li class="version">
<a href="../../9_0/index.html">9.0</a>
@@ -1040,6 +1040,13 @@
</li>
</ul>
</li>
+ <li class="nav-item" data-depth="0">
+<ul class="nav-list">
+ <li class="nav-item" data-depth="1">
+ <a class="nav-link" href="../how-to-contribute/how-to-contribute.html">How To Contribute</a>
+ </li>
+</ul>
+ </li>
</ul>
</nav>
</div>
@@ -1060,16 +1067,16 @@
</ul>
</nav>
<div class="page-versions">
- <button class="version-menu-toggle" title="Show other versions of page">9.1</button>
+ <button class="version-menu-toggle" title="Show other versions of page">9.2</button>
<div class="version-menu">
- <a class="version" href="../../9_2/deployment-guide/backup-restore.html">9.2-beta</a>
- <a class="version is-current" href="backup-restore.html">9.1</a>
+ <a class="version is-current" href="backup-restore.html">9.2</a>
+ <a class="version" href="../../9_1/deployment-guide/backup-restore.html">9.1</a>
<a class="version" href="../../9_0/deployment-guide/backup-restore.html">9.0</a>
</div>
</div>
<!-- Solr Additions - Start -->
<!-- Solr New File -->
-<span class="perma-link-copy" version="9_1">
+<span class="perma-link-copy" version="9_2">
</span><!-- Solr Additions - End -->
<div class="edit-this-page"><a href="https://github.com/apache/solr/tree/main/solr/solr-ref-guide/modules/deployment-guide/pages/backup-restore.adoc">Edit this Page</a></div>
</div>
@@ -1441,8 +1448,11 @@ While an ongoing restore operation is ha
If it failed then an "exception" will also be sent in the response.</p>
</div>
</div>
-<div class="sect2">
-<h3 id="create-snapshot-api"><a class="anchor" href="#create-snapshot-api"></a>Create Snapshot API</h3>
+</div>
+</div>
+<div class="sect1">
+<h2 id="create-snapshot-api"><a class="anchor" href="#create-snapshot-api"></a>CREATE: Create a Snapshot</h2>
+<div class="sectionbody">
<div class="paragraph">
<p>The snapshot functionality is different from the backup functionality as the index files aren’t copied anywhere.
The index files are snapshotted in the same index directory and can be referenced while taking backups.</p>
@@ -1450,53 +1460,44 @@ The index files are snapshotted in the s
<div class="paragraph">
<p>You can trigger a snapshot command with an HTTP command like this (replace "techproducts" with the name of the core you are working with):</p>
</div>
+<div class="openblock dynamic-tabs">
+<div class="content">
+<div id="v1createsnapshot" class="exampleblock tab-pane">
+<div class="content">
+<div class="paragraph">
+<p><strong class="tab-label">V1 API</strong></p>
+</div>
<div class="listingblock">
-<div class="title">Create Snapshot API Example</div>
<div class="content">
-<pre class="highlightjs highlight"><code class="language-text hljs" data-lang="text">http://localhost:8983/solr/admin/cores?action=CREATESNAPSHOT&core=techproducts&commitName=commit1</code></pre>
+<pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">curl -X POST http://localhost:8983/solr/admin/cores?action=CREATESNAPSHOT&core=techproducts&commitName=commit1</code></pre>
+</div>
+</div>
</div>
</div>
+<div id="v2createsnapshot" class="exampleblock tab-pane">
+<div class="content">
<div class="paragraph">
-<p>The <code>CREATESNAPSHOT</code> request parameters are:</p>
+<p><strong class="tab-label">V2 API</strong></p>
</div>
-<div class="dlist">
-<dl>
-<dt class="hdlist1"><code>commitName</code></dt>
-<dd>
-<table class="tableblock frame-none grid-all fit-content">
-<colgroup>
-<col>
-<col>
-</colgroup>
-<tbody>
-<tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock">Optional</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">Default: none</p></td>
-</tr>
-</tbody>
-</table>
<div class="paragraph">
-<p>The name to store the snapshot as.</p>
+<p>With the v2 API, the core and snapshot names are part of the path instead of query parameters.</p>
</div>
-</dd>
-<dt class="hdlist1"><code>core</code></dt>
-<dd>
-<table class="tableblock frame-none grid-all fit-content">
-<colgroup>
-<col>
-<col>
-</colgroup>
-<tbody>
-<tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock">Optional</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">Default: none</p></td>
-</tr>
-</tbody>
-</table>
+<div class="listingblock">
+<div class="content">
+<pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">curl -X POST http://localhost:8983/api/cores/techproducts/snapshots/commit1</code></pre>
+</div>
+</div>
+</div>
+</div>
+</div>
+</div>
+<div class="sect2">
+<h3 id="create-parameters"><a class="anchor" href="#create-parameters"></a>CREATE Parameters</h3>
<div class="paragraph">
-<p>The name of the core to perform the snapshot on.</p>
+<p>The CREATE action allows the following parameters:</p>
</div>
-</dd>
+<div class="dlist">
+<dl>
<dt class="hdlist1"><code>async</code></dt>
<dd>
<table class="tableblock frame-none grid-all fit-content">
@@ -1519,42 +1520,58 @@ The index files are snapshotted in the s
</div>
</div>
<div class="sect2">
-<h3 id="list-snapshot-api"><a class="anchor" href="#list-snapshot-api"></a>List Snapshot API</h3>
+<h3 id="create-response"><a class="anchor" href="#create-response"></a>CREATE Response</h3>
<div class="paragraph">
-<p>The <code>LISTSNAPSHOTS</code> command lists all the taken snapshots for a particular core.</p>
+<p>The response will include the status of the request, the core name, snapshot name, index directory path, snapshot generation, and a list of file names.
+If the status is anything other than "success", an error message will explain why the request failed.</p>
+</div>
+</div>
+</div>
</div>
+<div class="sect1">
+<h2 id="list-snapshot-api"><a class="anchor" href="#list-snapshot-api"></a>List: List All Snapshots for a Particular Core</h2>
+<div class="sectionbody">
<div class="paragraph">
<p>You can trigger a list snapshot command with an HTTP command like this (replace "techproducts" with the name of the core you are working with):</p>
</div>
+<div class="openblock dynamic-tabs">
+<div class="content">
+<div id="v1listsnapshots" class="exampleblock tab-pane">
+<div class="content">
+<div class="paragraph">
+<p><strong class="tab-label">V1 API</strong></p>
+</div>
<div class="listingblock">
-<div class="title">List Snapshot API</div>
<div class="content">
-<pre class="highlightjs highlight"><code class="language-text hljs" data-lang="text">http://localhost:8983/solr/admin/cores?action=LISTSNAPSHOTS&core=techproducts&commitName=commit1</code></pre>
+<pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">curl http://localhost:8983/solr/admin/cores?action=LISTSNAPSHOTS&core=techproducts&commitName=commit1</code></pre>
+</div>
+</div>
</div>
</div>
+<div id="v2listsnapshots" class="exampleblock tab-pane">
+<div class="content">
<div class="paragraph">
-<p>The list snapshot request parameters are:</p>
+<p><strong class="tab-label">V2 API</strong></p>
</div>
-<div class="dlist">
-<dl>
-<dt class="hdlist1"><code>core</code></dt>
-<dd>
-<table class="tableblock frame-none grid-all fit-content">
-<colgroup>
-<col>
-<col>
-</colgroup>
-<tbody>
-<tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock">Optional</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">Default: none</p></td>
-</tr>
-</tbody>
-</table>
<div class="paragraph">
-<p>The name of the core to whose snapshots we want to list.</p>
+<p>With the v2 API the core name appears in the path, instead of as a query parameter.</p>
</div>
-</dd>
+<div class="listingblock">
+<div class="content">
+<pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">curl http://localhost:8983/api/cores/techproducts/snapshots</code></pre>
+</div>
+</div>
+</div>
+</div>
+</div>
+</div>
+<div class="sect2">
+<h3 id="list-parameters"><a class="anchor" href="#list-parameters"></a>LIST Parameters</h3>
+<div class="paragraph">
+<p>The LIST action allows the following parameters:</p>
+</div>
+<div class="dlist">
+<dl>
<dt class="hdlist1"><code>async</code></dt>
<dd>
<table class="tableblock frame-none grid-all fit-content">
@@ -1577,60 +1594,58 @@ The index files are snapshotted in the s
</div>
</div>
<div class="sect2">
-<h3 id="delete-snapshot-api"><a class="anchor" href="#delete-snapshot-api"></a>Delete Snapshot API</h3>
+<h3 id="list-response"><a class="anchor" href="#list-response"></a>LIST Response</h3>
<div class="paragraph">
-<p>The <code>DELETESNAPSHOT</code> command deletes a snapshot for a particular core.</p>
+<p>The response will include the status of the request and all existing snapshots for the core.
+If the status is anything other than "success", an error message will explain why the request failed.</p>
+</div>
+</div>
+</div>
</div>
+<div class="sect1">
+<h2 id="delete-snapshot-api"><a class="anchor" href="#delete-snapshot-api"></a>DELETE: Delete a Snapshot</h2>
+<div class="sectionbody">
<div class="paragraph">
<p>You can trigger a delete snapshot with an HTTP command like this (replace "techproducts" with the name of the core you are working with):</p>
</div>
+<div class="openblock dynamic-tabs">
+<div class="content">
+<div id="v1deletesnapshot" class="exampleblock tab-pane">
+<div class="content">
+<div class="paragraph">
+<p><strong class="tab-label">V1 API</strong></p>
+</div>
<div class="listingblock">
-<div class="title">Delete Snapshot API Example</div>
<div class="content">
-<pre class="highlightjs highlight"><code class="language-text hljs" data-lang="text">http://localhost:8983/solr/admin/cores?action=DELETESNAPSHOT&core=techproducts&commitName=commit1</code></pre>
+<pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">curl http://localhost:8983/solr/admin/cores?action=DELETESNAPSHOT&core=techproducts&commitName=commit1</code></pre>
+</div>
+</div>
</div>
</div>
+<div id="v2deletesnapshot" class="exampleblock tab-pane">
+<div class="content">
<div class="paragraph">
-<p>The delete snapshot request parameters are:</p>
+<p><strong class="tab-label">V2 API</strong></p>
</div>
-<div class="dlist">
-<dl>
-<dt class="hdlist1"><code>commitName</code></dt>
-<dd>
-<table class="tableblock frame-none grid-all fit-content">
-<colgroup>
-<col>
-<col>
-</colgroup>
-<tbody>
-<tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock">Optional</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">Default: none</p></td>
-</tr>
-</tbody>
-</table>
<div class="paragraph">
-<p>Specify the commit name to be deleted.</p>
+<p>With the v2 API, the core and snapshot names are part of the path instead of query parameters.</p>
</div>
-</dd>
-<dt class="hdlist1"><code>core</code></dt>
-<dd>
-<table class="tableblock frame-none grid-all fit-content">
-<colgroup>
-<col>
-<col>
-</colgroup>
-<tbody>
-<tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock">Optional</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">Default: none</p></td>
-</tr>
-</tbody>
-</table>
+<div class="listingblock">
+<div class="content">
+<pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">curl -X DELETE http://localhost:8983/api/cores/techproducts/snapshots/commit1</code></pre>
+</div>
+</div>
+</div>
+</div>
+</div>
+</div>
+<div class="sect2">
+<h3 id="delete-parameters"><a class="anchor" href="#delete-parameters"></a>DELETE Parameters</h3>
<div class="paragraph">
-<p>The name of the core whose snapshot we want to delete.</p>
+<p>The DELETE action allows the following parameters:</p>
</div>
-</dd>
+<div class="dlist">
+<dl>
<dt class="hdlist1"><code>async</code></dt>
<dd>
<table class="tableblock frame-none grid-all fit-content">
@@ -1652,6 +1667,13 @@ The index files are snapshotted in the s
</dl>
</div>
</div>
+<div class="sect2">
+<h3 id="delete-response"><a class="anchor" href="#delete-response"></a>DELETE Response</h3>
+<div class="paragraph">
+<p>The response will include the status of the request, the core name, and the name of the snapshot that was deleted.
+If the status is anything other than "success", an error message will explain why the request failed.</p>
+</div>
+</div>
</div>
</div>
<div class="sect1">
@@ -1660,7 +1682,7 @@ The index files are snapshotted in the s
<div class="paragraph">
<p>Solr provides a repository abstraction to allow users to backup and restore their data to a variety of different storage systems.
For example, a Solr cluster running on a local filesystem (e.g., EXT3) can store backup data on the same disk, on a remote network-mounted drive, in HDFS, or even in some popular "cloud storage" providers, depending on the 'repository' implementation chosen.
-Solr offers three different repository implementations out of the box (<code>LocalFileSystemRepository</code>, <code>HdfsBackupRepository</code>, and <code>GCSBackupRepository</code>), and allows users to create plugins for their own storage systems as needed.</p>
+Solr offers multiple different repository implementations out of the box (<code>LocalFileSystemRepository</code>, <code>HdfsBackupRepository</code>, <code>GCSBackupRepository</code> and <code>S3BackupRepository</code>), and allows users to create plugins for their own storage systems as needed.</p>
</div>
<div class="paragraph">
<p>Users can define any number of repositories in their <code>solr.xml</code> file.
@@ -2189,9 +2211,9 @@ See the <code>gcsClientRpcTimeoutMultipl
<str name="location">/default/gcs/backup/location</str>
<int name="gcsClientMaxRetries">5</int>
- <int name="gcsClientHttpInitialHttpDelayMillis">1500</int>
+ <int name="gcsClientHttpInitialRetryDelayMillis">1500</int>
<double name="gcsClientHttpRetryDelayMultiplier">1.5</double>
- <int name="gcsClientMaxHttpRetryDelayMillis">10000</int>
+ <int name="gcsClientHttpMaxRetryDelayMillis">10000</int>
</repository>
</backup></code></pre>
</div>
Modified: sites/solr/guide/solr/latest/deployment-guide/basic-authentication-plugin.html
URL: http://svn.apache.org/viewvc/sites/solr/guide/solr/latest/deployment-guide/basic-authentication-plugin.html?rev=1082728&r1=1082727&r2=1082728&view=diff
==============================================================================
--- sites/solr/guide/solr/latest/deployment-guide/basic-authentication-plugin.html (original)
+++ sites/solr/guide/solr/latest/deployment-guide/basic-authentication-plugin.html Sat Mar 25 15:20:57 2023
@@ -39,7 +39,7 @@
<div class="navbar-item has-dropdown is-hoverable">
<a class="navbar-link" href="#">Resources</a>
<div class="navbar-dropdown">
- <a class="navbar-item" href="https://solr.apache.org/docs/9_1_1/index.html" target="_blank" rel="noreferrer nopener">Solr Javadocs</a>
+ <a class="navbar-item" href="https://solr.apache.org/docs/9_2_0/index.html" target="_blank" rel="noreferrer nopener">Solr Javadocs</a>
<a class="navbar-item" href="https://solr.apache.org/community.html#version-control" target="_blank" rel="noreferrer nopener">Source Code</a>
<a class="navbar-item" href="https://solr.apache.org/community.html" target="_blank" rel="noreferrer nopener">Community Links</a>
<a class="navbar-item" href="https://github.com/apache/solr/tree/main/dev-docs/ref-guide" target="_blank" rel="noreferrer nopener">Contribute</a>
@@ -56,25 +56,25 @@
</nav>
</header>
<div class="body">
-<div class="nav-container" data-component="solr" data-version="9_1">
+<div class="nav-container" data-component="solr" data-version="9_2">
<aside class="nav">
<div class="panels">
<!-- Solr Changes - Start -->
<div class="nav-panel-explore" data-panel="explore">
<div class="context">
<span class="title">Solr Reference Guide</span>
- <span class="version">9.1</span>
+ <span class="version">9.2</span>
</div>
<!-- Programmatically creates the component and version list -->
<ul class="components">
<li class="component is-current">
<a class="title" href="../index.html">Solr Reference Guide</a>
<ul class="versions">
- <li class="version">
- <a href="../../9_2/index.html">9.2-beta</a>
- </li>
<li class="version is-current is-latest">
- <a href="../index.html">9.1</a>
+ <a href="../index.html">9.2</a>
+ </li>
+ <li class="version">
+ <a href="../../9_1/index.html">9.1</a>
</li>
<li class="version">
<a href="../../9_0/index.html">9.0</a>
@@ -1040,6 +1040,13 @@
</li>
</ul>
</li>
+ <li class="nav-item" data-depth="0">
+<ul class="nav-list">
+ <li class="nav-item" data-depth="1">
+ <a class="nav-link" href="../how-to-contribute/how-to-contribute.html">How To Contribute</a>
+ </li>
+</ul>
+ </li>
</ul>
</nav>
</div>
@@ -1061,16 +1068,16 @@
</ul>
</nav>
<div class="page-versions">
- <button class="version-menu-toggle" title="Show other versions of page">9.1</button>
+ <button class="version-menu-toggle" title="Show other versions of page">9.2</button>
<div class="version-menu">
- <a class="version" href="../../9_2/deployment-guide/basic-authentication-plugin.html">9.2-beta</a>
- <a class="version is-current" href="basic-authentication-plugin.html">9.1</a>
+ <a class="version is-current" href="basic-authentication-plugin.html">9.2</a>
+ <a class="version" href="../../9_1/deployment-guide/basic-authentication-plugin.html">9.1</a>
<a class="version" href="../../9_0/deployment-guide/basic-authentication-plugin.html">9.0</a>
</div>
</div>
<!-- Solr Additions - Start -->
<!-- Solr New File -->
-<span class="perma-link-copy" version="9_1">
+<span class="perma-link-copy" version="9_2">
</span><!-- Solr Additions - End -->
<div class="edit-this-page"><a href="https://github.com/apache/solr/tree/main/solr/solr-ref-guide/modules/deployment-guide/pages/basic-authentication-plugin.adoc">Edit this Page</a></div>
</div>
@@ -1558,7 +1565,7 @@ SOLR_AUTHENTICATION_OPTS="-Dbasicauth=so
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">SOLR_AUTH_TYPE="basic"
-SOLR_AUTHENTICATION_OPTS="-Dsolr.httpclient.config=/path/to/solr-9.1.1/server/solr/basicAuth.conf"</code></pre>
+SOLR_AUTHENTICATION_OPTS="-Dsolr.httpclient.config=/path/to/solr-9.2.0/server/solr/basicAuth.conf"</code></pre>
</div>
</div>
</div>
Modified: sites/solr/guide/solr/latest/deployment-guide/cert-authentication-plugin.html
URL: http://svn.apache.org/viewvc/sites/solr/guide/solr/latest/deployment-guide/cert-authentication-plugin.html?rev=1082728&r1=1082727&r2=1082728&view=diff
==============================================================================
--- sites/solr/guide/solr/latest/deployment-guide/cert-authentication-plugin.html (original)
+++ sites/solr/guide/solr/latest/deployment-guide/cert-authentication-plugin.html Sat Mar 25 15:20:57 2023
@@ -39,7 +39,7 @@
<div class="navbar-item has-dropdown is-hoverable">
<a class="navbar-link" href="#">Resources</a>
<div class="navbar-dropdown">
- <a class="navbar-item" href="https://solr.apache.org/docs/9_1_1/index.html" target="_blank" rel="noreferrer nopener">Solr Javadocs</a>
+ <a class="navbar-item" href="https://solr.apache.org/docs/9_2_0/index.html" target="_blank" rel="noreferrer nopener">Solr Javadocs</a>
<a class="navbar-item" href="https://solr.apache.org/community.html#version-control" target="_blank" rel="noreferrer nopener">Source Code</a>
<a class="navbar-item" href="https://solr.apache.org/community.html" target="_blank" rel="noreferrer nopener">Community Links</a>
<a class="navbar-item" href="https://github.com/apache/solr/tree/main/dev-docs/ref-guide" target="_blank" rel="noreferrer nopener">Contribute</a>
@@ -56,25 +56,25 @@
</nav>
</header>
<div class="body">
-<div class="nav-container" data-component="solr" data-version="9_1">
+<div class="nav-container" data-component="solr" data-version="9_2">
<aside class="nav">
<div class="panels">
<!-- Solr Changes - Start -->
<div class="nav-panel-explore" data-panel="explore">
<div class="context">
<span class="title">Solr Reference Guide</span>
- <span class="version">9.1</span>
+ <span class="version">9.2</span>
</div>
<!-- Programmatically creates the component and version list -->
<ul class="components">
<li class="component is-current">
<a class="title" href="../index.html">Solr Reference Guide</a>
<ul class="versions">
- <li class="version">
- <a href="../../9_2/index.html">9.2-beta</a>
- </li>
<li class="version is-current is-latest">
- <a href="../index.html">9.1</a>
+ <a href="../index.html">9.2</a>
+ </li>
+ <li class="version">
+ <a href="../../9_1/index.html">9.1</a>
</li>
<li class="version">
<a href="../../9_0/index.html">9.0</a>
@@ -1040,6 +1040,13 @@
</li>
</ul>
</li>
+ <li class="nav-item" data-depth="0">
+<ul class="nav-list">
+ <li class="nav-item" data-depth="1">
+ <a class="nav-link" href="../how-to-contribute/how-to-contribute.html">How To Contribute</a>
+ </li>
+</ul>
+ </li>
</ul>
</nav>
</div>
@@ -1061,16 +1068,16 @@
</ul>
</nav>
<div class="page-versions">
- <button class="version-menu-toggle" title="Show other versions of page">9.1</button>
+ <button class="version-menu-toggle" title="Show other versions of page">9.2</button>
<div class="version-menu">
- <a class="version" href="../../9_2/deployment-guide/cert-authentication-plugin.html">9.2-beta</a>
- <a class="version is-current" href="cert-authentication-plugin.html">9.1</a>
+ <a class="version is-current" href="cert-authentication-plugin.html">9.2</a>
+ <a class="version" href="../../9_1/deployment-guide/cert-authentication-plugin.html">9.1</a>
<a class="version" href="../../9_0/deployment-guide/cert-authentication-plugin.html">9.0</a>
</div>
</div>
<!-- Solr Additions - Start -->
<!-- Solr New File -->
-<span class="perma-link-copy" version="9_1">
+<span class="perma-link-copy" version="9_2">
</span><!-- Solr Additions - End -->
<div class="edit-this-page"><a href="https://github.com/apache/solr/tree/main/solr/solr-ref-guide/modules/deployment-guide/pages/cert-authentication-plugin.adoc">Edit this Page</a></div>
</div>