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/07/21 18:07:51 UTC
svn commit: r1083697 [29/43] - 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/deployment-guide/replica-management.html
URL: http://svn.apache.org/viewvc/sites/solr/guide/solr/latest/deployment-guide/replica-management.html?rev=1083697&r1=1083696&r2=1083697&view=diff
==============================================================================
--- sites/solr/guide/solr/latest/deployment-guide/replica-management.html (original)
+++ sites/solr/guide/solr/latest/deployment-guide/replica-management.html Fri Jul 21 18:07:42 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_2_1/index.html" target="_blank" rel="noreferrer nopener">Solr Javadocs</a>
+ <a class="navbar-item" href="https://solr.apache.org/docs/9_3_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_2">
+<div class="nav-container" data-component="solr" data-version="9_3">
<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.2</span>
+ <span class="version">9.3</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_3/index.html">9.3-beta</a>
- </li>
<li class="version is-current is-latest">
- <a href="../index.html">9.2</a>
+ <a href="../index.html">9.3</a>
+ </li>
+ <li class="version">
+ <a href="../../9_2/index.html">9.2</a>
</li>
<li class="version">
<a href="../../9_1/index.html">9.1</a>
@@ -211,7 +211,7 @@
<a class="nav-link" href="../getting-started/tutorial-films.html">Exercise 2: Index Films Data</a>
</li>
<li class="nav-item" data-depth="2">
- <a class="nav-link" href="../getting-started/tutorial-diy.html">Exercise 3 Index Your Own Data</a>
+ <a class="nav-link" href="../getting-started/tutorial-diy.html">Exercise 3: Index Your Own Data</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../getting-started/tutorial-solrcloud.html">Getting Started with SolrCloud</a>
@@ -718,6 +718,9 @@
</ul>
</li>
<li class="nav-item" data-depth="2">
+ <a class="nav-link" href="../indexing-guide/indexing-with-cbor.html">Indexing with Update CBOR data format</a>
+ </li>
+ <li class="nav-item" data-depth="2">
<a class="nav-link" href="../indexing-guide/indexing-with-tika.html">Indexing with Solr Cell and Apache Tika</a>
</li>
<li class="nav-item" data-depth="2">
@@ -1072,17 +1075,17 @@
</ul>
</nav>
<div class="page-versions">
- <button class="version-menu-toggle" title="Show other versions of page">9.2</button>
+ <button class="version-menu-toggle" title="Show other versions of page">9.3</button>
<div class="version-menu">
- <a class="version" href="../../9_3/deployment-guide/replica-management.html">9.3-beta</a>
- <a class="version is-current" href="replica-management.html">9.2</a>
+ <a class="version is-current" href="replica-management.html">9.3</a>
+ <a class="version" href="../../9_2/deployment-guide/replica-management.html">9.2</a>
<a class="version" href="../../9_1/deployment-guide/replica-management.html">9.1</a>
<a class="version" href="../../9_0/deployment-guide/replica-management.html">9.0</a>
</div>
</div>
<!-- Solr Additions - Start -->
<!-- Solr New File -->
-<span class="perma-link-copy" version="9_2">
+<span class="perma-link-copy" version="9_3">
</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/replica-management.adoc">Edit this Page</a></div>
</div>
@@ -1160,12 +1163,9 @@ Otherwise, a set of nodes can be specifi
</div>
<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/collections/techproducts/shards -H 'Content-Type: application/json' -d '
+<pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">curl -X POST http://localhost:8983/api/collections/techproducts/shards/shard1/replicas -H 'Content-Type: application/json' -d '
{
- "add-replica":{
- "shard":"shard1",
- "node":"localhost:8983_solr"
- }
+ "node":"localhost:8983_solr"
}
'</code></pre>
</div>
@@ -1234,7 +1234,7 @@ Otherwise, a set of nodes can be specifi
<p>If <code>shard</code> is not specified, then <code>_route_</code> must be.</p>
</div>
</dd>
-<dt class="hdlist1"><code>_route_</code></dt>
+<dt class="hdlist1"><code>_route_</code> (v1), <code>route</code> (v2)</dt>
<dd>
<table class="tableblock frame-none grid-all fit-content">
<colgroup>
@@ -1273,7 +1273,7 @@ Otherwise, a set of nodes can be specifi
<p>The name of the node where the replica should be created.</p>
</div>
</dd>
-<dt class="hdlist1"><code>createNodeSet</code></dt>
+<dt class="hdlist1"><code>createNodeSet</code> (v1), <code>nodeSet</code> (v2)</dt>
<dd>
<table class="tableblock frame-none grid-all fit-content">
<colgroup>
@@ -1288,10 +1288,11 @@ Otherwise, a set of nodes can be specifi
</tbody>
</table>
<div class="paragraph">
-<p>A comma-separated list of nodes among which the best ones will be chosen to place the replicas.</p>
+<p>Placement candidates for the newly created replica(s).</p>
</div>
<div class="paragraph">
-<p>The format is a comma-separated list of node_names, such as <code>localhost:8983_solr,localhost:8984_solr,localhost:8985_solr</code>.</p>
+<p>Provided as a comma-separated list of node names in v1 requests, such as <code>localhost:8983_solr,localhost:8984_solr,localhost:8985_solr</code>.
+In v2 requests, <code>nodeSet</code> expects the values as a true list, such as <code>["localhost:8983_solr", "localhost:8984_solr", "localhost:8985_solr"]</code>.</p>
</div>
</dd>
</dl>
@@ -1303,7 +1304,7 @@ Otherwise, a set of nodes can be specifi
<i class="fa icon-note" title="Note"></i>
</td>
<td class="content">
-If neither <code>node</code> nor <code>createNodeSet</code> are specified then the best node(s) from among all the live nodes in the cluster are chosen.
+If neither <code>node</code> nor <code>createNodeSet</code>/<code>nodeSet</code> are specified then the best node(s) from among all the live nodes in the cluster are chosen.
</td>
</tr>
</table>
@@ -1454,7 +1455,7 @@ Defaults to <code>1</code> if <code>type
</tbody>
</table>
<div class="paragraph">
-<p>Set core property <em>name</em> to <em>value</em>.
+<p>Name/value pairs to use as additional properties in the created core.
See <a href="../configuration-guide/core-discovery.html" class="xref page">Core Discovery</a> for details about supported properties and values.</p>
</div>
</dd>
@@ -1807,11 +1808,27 @@ Defaults to <code>true</code>, but is ig
<h2 id="deletereplica"><a class="anchor" href="#deletereplica"></a>DELETEREPLICA: Delete a Replica</h2>
<div class="sectionbody">
<div class="paragraph">
-<p>Deletes a named replica from the specified collection and shard.</p>
+<p>Allows deletion of one or more replicas. The replicas to be deleted can be specified in multiple ways:</p>
+</div>
+<div class="olist arabic">
+<ol class="arabic">
+<li>
+<p>A single, specific replica can be deleted by if the associated collection, shard and replica name are all provided.</p>
+</li>
+<li>
+<p>Multiple replicas can be deleted from a specific shard if the associated collection and shard names are provided, along with a <code>count</code> of the replicas to delete.</p>
+</li>
+<li>
+<p>Multiple replicas can be deleted from <em>all</em> shards in a collection if the associated collection name is provided, along with a <code>count</code> of the replicas to delete.</p>
+</li>
+</ol>
</div>
<div class="paragraph">
-<p>If the corresponding core is up and running the core is unloaded, the entry is removed from the clusterstate, and (by default) delete the instanceDir and dataDir.
-If the node/core is down, the entry is taken off the clusterstate and if the core comes up later it is automatically unregistered.</p>
+<p>When deleting multiple replicas, Solr chooses replicas which are active, up to date, and not currently the leader.</p>
+</div>
+<div class="paragraph">
+<p>For each replica being deleted, if the corresponding core is up and running the core is unloaded, the entry is removed from the clusterstate, and (by default) the instanceDir and dataDir are deleted.
+If the core underlying the replica is down, the entry is taken off the clusterstate and if the core comes up later it is automatically unregistered.</p>
</div>
<div class="openblock dynamic-tabs">
<div class="content">
@@ -1832,17 +1849,35 @@ If the node/core is down, the entry is t
<div class="paragraph">
<p><strong class="tab-label">V2 API</strong></p>
</div>
+<div class="paragraph">
+<p>The v2 API has three distinct endpoints for replica-deletion, depending on how the replicas are specified.</p>
+</div>
+<div class="paragraph">
+<p>To delete a replica by name:</p>
+</div>
+<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/collections/techproducts/shards/shard1/replicas/core_node2</code></pre>
+</div>
+</div>
+<div class="paragraph">
+<p>To delete a specified number of (unnamed) replicas from a single shard:</p>
+</div>
<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/collections/techproducts/shards/shard1/core_node2</code></pre>
+<pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">curl -X DELETE "http://localhost:8983/api/collections/techproducts/shards/shard1/replicas?count=3"</code></pre>
</div>
</div>
<div class="paragraph">
-<p>To run a DELETE asynchronously then append the <code>async</code> parameter:</p>
+<p>To delete a specified number of (unnamed) replicas from all shards:</p>
</div>
<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/collections/techproducts/shards/shard1/core_node2?async=aaaa</code></pre>
+<pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">curl -X PUT -H "Content-type: application/json" "http://localhost:8983/api/collections/techproducts/scale" -d '
+ {
+ "count": 3
+ }
+'</code></pre>
</div>
</div>
</div>
@@ -1868,7 +1903,8 @@ If the node/core is down, the entry is t
</tbody>
</table>
<div class="paragraph">
-<p>The name of the collection.</p>
+<p>The name of the collection.
+Provided as a query parameter or a path parameter in v1 and v2 requests, respectively.</p>
</div>
</dd>
<dt class="hdlist1"><code>shard</code></dt>
@@ -1886,7 +1922,8 @@ If the node/core is down, the entry is t
</tbody>
</table>
<div class="paragraph">
-<p>The name of the shard that includes the replica to be removed.</p>
+<p>The name of the shard that includes the replica to be removed.
+Provided as a query parameter or a path parameter in v1 and v2 requests, respectively.</p>
</div>
</dd>
<dt class="hdlist1"><code>replica</code></dt>
@@ -1904,7 +1941,8 @@ If the node/core is down, the entry is t
</tbody>
</table>
<div class="paragraph">
-<p>The name of the replica to remove.</p>
+<p>The name of the replica to remove.
+Provided as a query parameter or a path parameter in v1 and v2 requests, respectively.</p>
</div>
<div class="paragraph">
<p>If <code>count</code> is used instead, this parameter is not required.
@@ -2010,6 +2048,24 @@ Set this to <code>false</code> to preven
<p>When set to <code>true</code>, no action will be taken if the replica is active.</p>
</div>
</dd>
+<dt class="hdlist1"><code>followAliases</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: false</p></td>
+</tr>
+</tbody>
+</table>
+<div class="paragraph">
+<p>A flag that allows treating the collection parameter as an alias for the actual collection name to be resolved.</p>
+</div>
+</dd>
<dt class="hdlist1"><code>async</code></dt>
<dd>
<table class="tableblock frame-none grid-all fit-content">
Modified: sites/solr/guide/solr/latest/deployment-guide/ruby.html
URL: http://svn.apache.org/viewvc/sites/solr/guide/solr/latest/deployment-guide/ruby.html?rev=1083697&r1=1083696&r2=1083697&view=diff
==============================================================================
--- sites/solr/guide/solr/latest/deployment-guide/ruby.html (original)
+++ sites/solr/guide/solr/latest/deployment-guide/ruby.html Fri Jul 21 18:07:42 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_2_1/index.html" target="_blank" rel="noreferrer nopener">Solr Javadocs</a>
+ <a class="navbar-item" href="https://solr.apache.org/docs/9_3_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_2">
+<div class="nav-container" data-component="solr" data-version="9_3">
<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.2</span>
+ <span class="version">9.3</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_3/index.html">9.3-beta</a>
- </li>
<li class="version is-current is-latest">
- <a href="../index.html">9.2</a>
+ <a href="../index.html">9.3</a>
+ </li>
+ <li class="version">
+ <a href="../../9_2/index.html">9.2</a>
</li>
<li class="version">
<a href="../../9_1/index.html">9.1</a>
@@ -211,7 +211,7 @@
<a class="nav-link" href="../getting-started/tutorial-films.html">Exercise 2: Index Films Data</a>
</li>
<li class="nav-item" data-depth="2">
- <a class="nav-link" href="../getting-started/tutorial-diy.html">Exercise 3 Index Your Own Data</a>
+ <a class="nav-link" href="../getting-started/tutorial-diy.html">Exercise 3: Index Your Own Data</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../getting-started/tutorial-solrcloud.html">Getting Started with SolrCloud</a>
@@ -718,6 +718,9 @@
</ul>
</li>
<li class="nav-item" data-depth="2">
+ <a class="nav-link" href="../indexing-guide/indexing-with-cbor.html">Indexing with Update CBOR data format</a>
+ </li>
+ <li class="nav-item" data-depth="2">
<a class="nav-link" href="../indexing-guide/indexing-with-tika.html">Indexing with Solr Cell and Apache Tika</a>
</li>
<li class="nav-item" data-depth="2">
@@ -1070,17 +1073,17 @@
</ul>
</nav>
<div class="page-versions">
- <button class="version-menu-toggle" title="Show other versions of page">9.2</button>
+ <button class="version-menu-toggle" title="Show other versions of page">9.3</button>
<div class="version-menu">
- <a class="version" href="../../9_3/deployment-guide/ruby.html">9.3-beta</a>
- <a class="version is-current" href="ruby.html">9.2</a>
+ <a class="version is-current" href="ruby.html">9.3</a>
+ <a class="version" href="../../9_2/deployment-guide/ruby.html">9.2</a>
<a class="version" href="../../9_1/deployment-guide/ruby.html">9.1</a>
<a class="version" href="../../9_0/deployment-guide/ruby.html">9.0</a>
</div>
</div>
<!-- Solr Additions - Start -->
<!-- Solr New File -->
-<span class="perma-link-copy" version="9_2">
+<span class="perma-link-copy" version="9_3">
</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/ruby.adoc">Edit this Page</a></div>
</div>
Modified: sites/solr/guide/solr/latest/deployment-guide/rule-based-authorization-plugin.html
URL: http://svn.apache.org/viewvc/sites/solr/guide/solr/latest/deployment-guide/rule-based-authorization-plugin.html?rev=1083697&r1=1083696&r2=1083697&view=diff
==============================================================================
--- sites/solr/guide/solr/latest/deployment-guide/rule-based-authorization-plugin.html (original)
+++ sites/solr/guide/solr/latest/deployment-guide/rule-based-authorization-plugin.html Fri Jul 21 18:07:42 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_2_1/index.html" target="_blank" rel="noreferrer nopener">Solr Javadocs</a>
+ <a class="navbar-item" href="https://solr.apache.org/docs/9_3_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_2">
+<div class="nav-container" data-component="solr" data-version="9_3">
<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.2</span>
+ <span class="version">9.3</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_3/index.html">9.3-beta</a>
- </li>
<li class="version is-current is-latest">
- <a href="../index.html">9.2</a>
+ <a href="../index.html">9.3</a>
+ </li>
+ <li class="version">
+ <a href="../../9_2/index.html">9.2</a>
</li>
<li class="version">
<a href="../../9_1/index.html">9.1</a>
@@ -211,7 +211,7 @@
<a class="nav-link" href="../getting-started/tutorial-films.html">Exercise 2: Index Films Data</a>
</li>
<li class="nav-item" data-depth="2">
- <a class="nav-link" href="../getting-started/tutorial-diy.html">Exercise 3 Index Your Own Data</a>
+ <a class="nav-link" href="../getting-started/tutorial-diy.html">Exercise 3: Index Your Own Data</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../getting-started/tutorial-solrcloud.html">Getting Started with SolrCloud</a>
@@ -718,6 +718,9 @@
</ul>
</li>
<li class="nav-item" data-depth="2">
+ <a class="nav-link" href="../indexing-guide/indexing-with-cbor.html">Indexing with Update CBOR data format</a>
+ </li>
+ <li class="nav-item" data-depth="2">
<a class="nav-link" href="../indexing-guide/indexing-with-tika.html">Indexing with Solr Cell and Apache Tika</a>
</li>
<li class="nav-item" data-depth="2">
@@ -1071,17 +1074,17 @@
</ul>
</nav>
<div class="page-versions">
- <button class="version-menu-toggle" title="Show other versions of page">9.2</button>
+ <button class="version-menu-toggle" title="Show other versions of page">9.3</button>
<div class="version-menu">
- <a class="version" href="../../9_3/deployment-guide/rule-based-authorization-plugin.html">9.3-beta</a>
- <a class="version is-current" href="rule-based-authorization-plugin.html">9.2</a>
+ <a class="version is-current" href="rule-based-authorization-plugin.html">9.3</a>
+ <a class="version" href="../../9_2/deployment-guide/rule-based-authorization-plugin.html">9.2</a>
<a class="version" href="../../9_1/deployment-guide/rule-based-authorization-plugin.html">9.1</a>
<a class="version" href="../../9_0/deployment-guide/rule-based-authorization-plugin.html">9.0</a>
</div>
</div>
<!-- Solr Additions - Start -->
<!-- Solr New File -->
-<span class="perma-link-copy" version="9_2">
+<span class="perma-link-copy" version="9_3">
</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/rule-based-authorization-plugin.adoc">Edit this Page</a></div>
</div>
Modified: sites/solr/guide/solr/latest/deployment-guide/securing-solr.html
URL: http://svn.apache.org/viewvc/sites/solr/guide/solr/latest/deployment-guide/securing-solr.html?rev=1083697&r1=1083696&r2=1083697&view=diff
==============================================================================
--- sites/solr/guide/solr/latest/deployment-guide/securing-solr.html (original)
+++ sites/solr/guide/solr/latest/deployment-guide/securing-solr.html Fri Jul 21 18:07:42 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_2_1/index.html" target="_blank" rel="noreferrer nopener">Solr Javadocs</a>
+ <a class="navbar-item" href="https://solr.apache.org/docs/9_3_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_2">
+<div class="nav-container" data-component="solr" data-version="9_3">
<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.2</span>
+ <span class="version">9.3</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_3/index.html">9.3-beta</a>
- </li>
<li class="version is-current is-latest">
- <a href="../index.html">9.2</a>
+ <a href="../index.html">9.3</a>
+ </li>
+ <li class="version">
+ <a href="../../9_2/index.html">9.2</a>
</li>
<li class="version">
<a href="../../9_1/index.html">9.1</a>
@@ -211,7 +211,7 @@
<a class="nav-link" href="../getting-started/tutorial-films.html">Exercise 2: Index Films Data</a>
</li>
<li class="nav-item" data-depth="2">
- <a class="nav-link" href="../getting-started/tutorial-diy.html">Exercise 3 Index Your Own Data</a>
+ <a class="nav-link" href="../getting-started/tutorial-diy.html">Exercise 3: Index Your Own Data</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../getting-started/tutorial-solrcloud.html">Getting Started with SolrCloud</a>
@@ -718,6 +718,9 @@
</ul>
</li>
<li class="nav-item" data-depth="2">
+ <a class="nav-link" href="../indexing-guide/indexing-with-cbor.html">Indexing with Update CBOR data format</a>
+ </li>
+ <li class="nav-item" data-depth="2">
<a class="nav-link" href="../indexing-guide/indexing-with-tika.html">Indexing with Solr Cell and Apache Tika</a>
</li>
<li class="nav-item" data-depth="2">
@@ -1069,17 +1072,17 @@
</ul>
</nav>
<div class="page-versions">
- <button class="version-menu-toggle" title="Show other versions of page">9.2</button>
+ <button class="version-menu-toggle" title="Show other versions of page">9.3</button>
<div class="version-menu">
- <a class="version" href="../../9_3/deployment-guide/securing-solr.html">9.3-beta</a>
- <a class="version is-current" href="securing-solr.html">9.2</a>
+ <a class="version is-current" href="securing-solr.html">9.3</a>
+ <a class="version" href="../../9_2/deployment-guide/securing-solr.html">9.2</a>
<a class="version" href="../../9_1/deployment-guide/securing-solr.html">9.1</a>
<a class="version" href="../../9_0/deployment-guide/securing-solr.html">9.0</a>
</div>
</div>
<!-- Solr Additions - Start -->
<!-- Solr New File -->
-<span class="perma-link-copy" version="9_2">
+<span class="perma-link-copy" version="9_3">
</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/securing-solr.adoc">Edit this Page</a></div>
</div>
Modified: sites/solr/guide/solr/latest/deployment-guide/security-ui.html
URL: http://svn.apache.org/viewvc/sites/solr/guide/solr/latest/deployment-guide/security-ui.html?rev=1083697&r1=1083696&r2=1083697&view=diff
==============================================================================
--- sites/solr/guide/solr/latest/deployment-guide/security-ui.html (original)
+++ sites/solr/guide/solr/latest/deployment-guide/security-ui.html Fri Jul 21 18:07:42 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_2_1/index.html" target="_blank" rel="noreferrer nopener">Solr Javadocs</a>
+ <a class="navbar-item" href="https://solr.apache.org/docs/9_3_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_2">
+<div class="nav-container" data-component="solr" data-version="9_3">
<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.2</span>
+ <span class="version">9.3</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_3/index.html">9.3-beta</a>
- </li>
<li class="version is-current is-latest">
- <a href="../index.html">9.2</a>
+ <a href="../index.html">9.3</a>
+ </li>
+ <li class="version">
+ <a href="../../9_2/index.html">9.2</a>
</li>
<li class="version">
<a href="../../9_1/index.html">9.1</a>
@@ -211,7 +211,7 @@
<a class="nav-link" href="../getting-started/tutorial-films.html">Exercise 2: Index Films Data</a>
</li>
<li class="nav-item" data-depth="2">
- <a class="nav-link" href="../getting-started/tutorial-diy.html">Exercise 3 Index Your Own Data</a>
+ <a class="nav-link" href="../getting-started/tutorial-diy.html">Exercise 3: Index Your Own Data</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../getting-started/tutorial-solrcloud.html">Getting Started with SolrCloud</a>
@@ -718,6 +718,9 @@
</ul>
</li>
<li class="nav-item" data-depth="2">
+ <a class="nav-link" href="../indexing-guide/indexing-with-cbor.html">Indexing with Update CBOR data format</a>
+ </li>
+ <li class="nav-item" data-depth="2">
<a class="nav-link" href="../indexing-guide/indexing-with-tika.html">Indexing with Solr Cell and Apache Tika</a>
</li>
<li class="nav-item" data-depth="2">
@@ -1070,17 +1073,17 @@
</ul>
</nav>
<div class="page-versions">
- <button class="version-menu-toggle" title="Show other versions of page">9.2</button>
+ <button class="version-menu-toggle" title="Show other versions of page">9.3</button>
<div class="version-menu">
- <a class="version" href="../../9_3/deployment-guide/security-ui.html">9.3-beta</a>
- <a class="version is-current" href="security-ui.html">9.2</a>
+ <a class="version is-current" href="security-ui.html">9.3</a>
+ <a class="version" href="../../9_2/deployment-guide/security-ui.html">9.2</a>
<a class="version" href="../../9_1/deployment-guide/security-ui.html">9.1</a>
<a class="version" href="../../9_0/deployment-guide/security-ui.html">9.0</a>
</div>
</div>
<!-- Solr Additions - Start -->
<!-- Solr New File -->
-<span class="perma-link-copy" version="9_2">
+<span class="perma-link-copy" version="9_3">
</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/security-ui.adoc">Edit this Page</a></div>
</div>
Modified: sites/solr/guide/solr/latest/deployment-guide/shard-management.html
URL: http://svn.apache.org/viewvc/sites/solr/guide/solr/latest/deployment-guide/shard-management.html?rev=1083697&r1=1083696&r2=1083697&view=diff
==============================================================================
--- sites/solr/guide/solr/latest/deployment-guide/shard-management.html (original)
+++ sites/solr/guide/solr/latest/deployment-guide/shard-management.html Fri Jul 21 18:07:42 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_2_1/index.html" target="_blank" rel="noreferrer nopener">Solr Javadocs</a>
+ <a class="navbar-item" href="https://solr.apache.org/docs/9_3_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_2">
+<div class="nav-container" data-component="solr" data-version="9_3">
<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.2</span>
+ <span class="version">9.3</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_3/index.html">9.3-beta</a>
- </li>
<li class="version is-current is-latest">
- <a href="../index.html">9.2</a>
+ <a href="../index.html">9.3</a>
+ </li>
+ <li class="version">
+ <a href="../../9_2/index.html">9.2</a>
</li>
<li class="version">
<a href="../../9_1/index.html">9.1</a>
@@ -211,7 +211,7 @@
<a class="nav-link" href="../getting-started/tutorial-films.html">Exercise 2: Index Films Data</a>
</li>
<li class="nav-item" data-depth="2">
- <a class="nav-link" href="../getting-started/tutorial-diy.html">Exercise 3 Index Your Own Data</a>
+ <a class="nav-link" href="../getting-started/tutorial-diy.html">Exercise 3: Index Your Own Data</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../getting-started/tutorial-solrcloud.html">Getting Started with SolrCloud</a>
@@ -718,6 +718,9 @@
</ul>
</li>
<li class="nav-item" data-depth="2">
+ <a class="nav-link" href="../indexing-guide/indexing-with-cbor.html">Indexing with Update CBOR data format</a>
+ </li>
+ <li class="nav-item" data-depth="2">
<a class="nav-link" href="../indexing-guide/indexing-with-tika.html">Indexing with Solr Cell and Apache Tika</a>
</li>
<li class="nav-item" data-depth="2">
@@ -1072,17 +1075,17 @@
</ul>
</nav>
<div class="page-versions">
- <button class="version-menu-toggle" title="Show other versions of page">9.2</button>
+ <button class="version-menu-toggle" title="Show other versions of page">9.3</button>
<div class="version-menu">
- <a class="version" href="../../9_3/deployment-guide/shard-management.html">9.3-beta</a>
- <a class="version is-current" href="shard-management.html">9.2</a>
+ <a class="version is-current" href="shard-management.html">9.3</a>
+ <a class="version" href="../../9_2/deployment-guide/shard-management.html">9.2</a>
<a class="version" href="../../9_1/deployment-guide/shard-management.html">9.1</a>
<a class="version" href="../../9_0/deployment-guide/shard-management.html">9.0</a>
</div>
</div>
<!-- Solr Additions - Start -->
<!-- Solr New File -->
-<span class="perma-link-copy" version="9_2">
+<span class="perma-link-copy" version="9_3">
</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/shard-management.adoc">Edit this Page</a></div>
</div>
@@ -1564,9 +1567,7 @@ A new shard with a name can be created f
<div class="content">
<pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">curl -X POST http://localhost:8983/api/collections/techproducts/shards -H 'Content-Type: application/json' -d '
{
- "create":{
- "shard":"newShardName"
- }
+ "shard":"newShardName"
}
'</code></pre>
</div>
@@ -1611,7 +1612,8 @@ This can be customized by explicitly pas
</tbody>
</table>
<div class="paragraph">
-<p>The name of the collection that includes the shard to be split.</p>
+<p>The name of the collection that includes the shard to be split.
+Provided as a query parameter in v1 requests, and as a path parameter for v2 requests.</p>
</div>
</dd>
<dt class="hdlist1"><code>shard</code></dt>
@@ -1810,14 +1812,6 @@ It will only remove shards that are inac
<pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">curl -X DELETE http://localhost:8983/api/collections/techproducts/shards/shard1</code></pre>
</div>
</div>
-<div class="paragraph">
-<p>To run a DELETE asynchronously then append the <code>async</code> parameter:</p>
-</div>
-<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/collections/techproducts/shards/shard1?async=aaaa</code></pre>
-</div>
-</div>
</div>
</div>
</div>
@@ -1841,7 +1835,8 @@ It will only remove shards that are inac
</tbody>
</table>
<div class="paragraph">
-<p>The name of the collection that includes the shard to be deleted.</p>
+<p>The name of the collection that includes the shard to be deleted.
+Provided as a query parameter or a path parameter in v1 and v2 requests, respectively.</p>
</div>
</dd>
<dt class="hdlist1"><code>shard</code></dt>
@@ -1859,7 +1854,8 @@ It will only remove shards that are inac
</tbody>
</table>
<div class="paragraph">
-<p>The name of the shard to be deleted.</p>
+<p>The name of the shard to be deleted.
+Provided as a query parameter or a path parameter in v1 and v2 requests, respectively.</p>
</div>
</dd>
<dt class="hdlist1"><code>deleteInstanceDir</code></dt>
@@ -1919,6 +1915,24 @@ Set this to <code>false</code> to preven
Set this to <code>false</code> to prevent the index directory from being deleted.</p>
</div>
</dd>
+<dt class="hdlist1"><code>followAliases</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: false</p></td>
+</tr>
+</tbody>
+</table>
+<div class="paragraph">
+<p>A flag that allows treating the collection parameter as an alias for the actual collection name to be resolved.</p>
+</div>
+</dd>
<dt class="hdlist1"><code>async</code></dt>
<dd>
<table class="tableblock frame-none grid-all fit-content">
@@ -1993,11 +2007,7 @@ If the status is anything other than "su
</div>
<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/collections/techproducts/shards/shard1 -H 'Content-Type: application/json' -d '
- {
- "force-leader":{}
- }
-'</code></pre>
+<pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">curl -X POST http://localhost:8983/api/collections/techproducts/shards/shard1/force-leader</code></pre>
</div>
</div>
<div class="paragraph">
@@ -2076,6 +2086,194 @@ This may potentially lead to loss of dat
</div>
</div>
</div>
+</div>
+<div class="sect1">
+<h2 id="installsharddata"><a class="anchor" href="#installsharddata"></a>INSTALLSHARDDATA: Install/Import Data to Shard</h2>
+<div class="sectionbody">
+<div class="paragraph">
+<p>Under normal circumstances, data is added to Solr collections (and the shards that make them up) by <a href="../indexing-guide/indexing-with-update-handlers.html" class="xref page">indexing</a> documents.
+However some use-cases require constructing per-shard indices offline.
+Often this is done as a means of insulating query traffic from indexing load, or because the ETL pipeline in use is particularly complex.
+The INSTALLSHARDDATA API allows installation of these pre-constructed indices into individual shards within a collection.
+Installation copies the index files into all replicas within the shard, overwriting any preexisting data held by that shard.</p>
+</div>
+<div class="paragraph">
+<p>To install data into a shard, the collection owning that shard must first be put into "readOnly" mode, using the <a href="collection-management.html#modifycollection" class="xref page">MODIFYCOLLECTION API</a>.
+Once in read-only mode, shard installation may be done either serially or in parallel.
+Data can be imported from any <code>repository</code> and <code>location</code> supported by Solr’s pluggable <a href="backup-restore.html#backuprestore-storage-repositories" class="xref page">Backup Repository</a> abstraction.</p>
+</div>
+<div class="paragraph">
+<p>The specified <code>location</code> must contain all files that make up a core’s <code>data/index</code> directory.
+Users are responsible for ensuring that the index installed to a shard is compatible with the schema and configuration for the collection hosting that shard.</p>
+</div>
+<div class="openblock dynamic-tabs">
+<div class="content">
+<div id="v1installshard" class="exampleblock tab-pane">
+<div class="content">
+<div class="paragraph">
+<p><strong class="tab-label">V1 API</strong></p>
+</div>
+<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=INSTALLSHARDDATA&collection=techproducts&shard=shard1&repository=localfs&location=/mounts/myNFSDrive/tech/shard1/data/index</code></pre>
+</div>
+</div>
+<div class="paragraph">
+<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": 78
+ }
+}</code></pre>
+</div>
+</div>
+</div>
+</div>
+<div id="v2installshard" class="exampleblock tab-pane">
+<div class="content">
+<div class="paragraph">
+<p><strong class="tab-label">V2 API</strong>
+<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 POST http://localhost:8983/api/collections/techproducts/shards/shard1/install -H 'Content-Type: application/json' -d '
+ {
+ "repository": "localfs",
+ "location": "/mounts/myNFSDrive/tech/shard1/data/index"
+ }
+'</code></pre>
+</div>
+</div>
+<div class="paragraph">
+<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": 125
+ }
+}</code></pre>
+</div>
+</div>
+</div>
+</div>
+</div>
+</div>
+<div class="sect2">
+<h3 id="installsharddata-parameters"><a class="anchor" href="#installsharddata-parameters"></a>INSTALLSHARDDATA Parameters</h3>
+<div class="dlist">
+<dl>
+<dt class="hdlist1"><code>collection</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"><strong>Required</strong></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 collection.
+This parameter is required.
+Specified as a query parameter for v1 requests, and as a path segment for v2 requests.</p>
+</div>
+</dd>
+<dt class="hdlist1"><code>shard</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"><strong>Required</strong></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 shard to install data to.
+This parameter is required.
+Specified as a query parameter for v1 requests, and as a path segment for v2 requests.</p>
+</div>
+</dd>
+<dt class="hdlist1"><code>location</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"><strong>Required</strong></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Default: none</p></td>
+</tr>
+</tbody>
+</table>
+<div class="paragraph">
+<p>The location within the specified backup repository to find the index files to install.
+Specified as a query parameter for v1 requests, and in the request body of v2 requests.</p>
+</div>
+</dd>
+<dt class="hdlist1"><code>repository</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 backup repository to look for index files within
+Specified as a query parameter for v1 requests, and in the request body of v2 requests.
+Solr’s default Backup Repository (if one is defined in solr.xml) will be used as a fallback if no repository parameter is provided.</p>
+</div>
+</dd>
+<dt class="hdlist1"><code>async</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>Request ID to track this action which will be <a href="../configuration-guide/collections-api.html#asynchronous-calls" class="xref page">processed asynchronously</a>.</p>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+</div>
</div>
</article>
</div>