You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucene.apache.org by ct...@apache.org on 2020/07/15 16:52:39 UTC
svn commit: r1063067 [9/28] - in
/websites/production/lucene/content/solr/guide/8_6: ./ meta-docs/
Modified: websites/production/lucene/content/solr/guide/8_6/how-to-contribute.html
==============================================================================
--- websites/production/lucene/content/solr/guide/8_6/how-to-contribute.html (original)
+++ websites/production/lucene/content/solr/guide/8_6/how-to-contribute.html Wed Jul 15 16:52:36 2020
@@ -8,7 +8,7 @@
<meta name="description" content="">
<meta name="keywords" content=" ">
-<title>How to Contribute to Solr Documentation | Apache Solr Reference Guide 8.6-DRAFT</title>
+<title>How to Contribute to Solr Documentation | Apache Solr Reference Guide 8.6</title>
<link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.1.3/css/bootstrap.min.css" integrity="sha384-MCw98/SFnGE8fJT3GXwEOngsV7Zt27NXFoaoApmYm81iuXoPkFOJwJ8ERdknLPMO" crossorigin="anonymous">
<link rel="stylesheet" type="text/css" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.5.0/css/font-awesome.min.css">
@@ -71,7 +71,7 @@
</script>
</head>
-<body class="DRAFT" id="how-to-contribute">
+<body class="" id="how-to-contribute">
<div class="container-fluid">
<div class="row">
<nav id="sidebar" class="col-2 d-none d-md-block">
@@ -79,11 +79,6 @@
<div class="sidebar-header">
<div class="sidebarTitle text-center">Apache Solr Reference Guide</div>
- <p class="draft-notice">
- This is an unofficial DRAFT of the Guide for 8.6.
- <a href="https://lucene.apache.org/solr/guide/">Official releases are available from the Solr website</a>.
- </p>
-
<!--comment out this block if you want to hide search-->
<!--start search-->
@@ -1764,24 +1759,24 @@ Field definitions can have the following
<div class="dlist"><dl><dt>Example</dt><dd><p>Take this example from <code>configsets-api.adoc</code>:</p><div class="listingblock"><pre class="rouge highlight"><code><pre class="highlight"><code>[[configsets-create]]
== Create a ConfigSet</code></pre></code></pre></div>
<p>To link to this section, there are two approaches depending on where you are linking from:</p>
-<ul><li>From the same page, simply use the anchor name: <code><<configsets-create>></code>.</li><li>From another page, use the page name and the anchor name: <code><<configsets-api.adoc#configsets-create>></code>.</li></ul></dd></dl></div></section>
+<ul><li><p>From the same page, simply use the anchor name: <code><<configsets-create>></code>.</p></li><li><p>From another page, use the page name and the anchor name: <code><<configsets-api.adoc#configsets-create>></code>.</p></li></ul></dd></dl></div></section>
<section class="sect4"><h5 id="link-to-another-page">Link to Another Page</h5><p>To link to <em>another page</em> or a section on another page, you must refer to the full filename and refer to the section you want to link to.</p>
<p>Unfortunately, when you want to refer the reader to another page without deep-linking to a section, you cannot simply put the other file name in angle brackets and call it a day.
<strong>You must always link to a specific section</strong>. If all you want is a reference to the top of another page, you can use the implicit <code>id</code> of the page — the filename w/o the <code>.adoc</code> extension — as your anchor reference.</p>
<div class="dlist"><dl><dt>Example</dt><dd><p>To construct a link to the <code>upgrading-solr.adoc</code> page, we need to refer to the file name (<code>upgrading-solr.adoc</code>), then use the page id (<code>upgrading-solr</code>) as the anchor reference. As in:</p><div class="listingblock"><pre class="rouge highlight"><code><pre class="highlight"><code>For more information about upgrades, see <<upgrading-solr.adoc#upgrading-solr>>.</code></pre></code></pre></div></dd></dl></div></section>
<section class="sect4"><h5 id="link-to-a-section-on-another-page">Link to a Section on Another Page</h5><p>Linking to a section is the same conceptually as linking to the top of a page, you just need to take a little extra care to format the anchor ID in your link reference properly.</p>
<p>When you link to a section on another page, you must make a simple conversion of the title into the format the section ID will be created during the conversion. These are the rules that transform the sections:</p>
-<div class="openblock"><div class="content d-flex flex-row"><div class="ulist"><ul><li>All characters are lower-cased.<ul><li><code>Using security.json with Solr</code> becomes <code>using security.json with solr</code></li></ul></li><li>All non-alpha characters are removed, with the exception of hyphens (so all periods, commas, ampersands, parentheses, etc., are stripped).<ul><li><code>using security.json with solr</code> becomes <code>using security json with solr</code></li></ul></li><li>All whitespaces are replaced with hyphens.<ul><li><code>using security json with solr</code> becomes <code>using-security-json-with-solr</code></li></ul></li></ul></div></div></div>
+<div class="openblock"><div class="content d-flex flex-row"><div class="ulist"><ul><li><p>All characters are lower-cased.<ul><li><p><code>Using security.json with Solr</code> becomes <code>using security.json with solr</code></p></li></ul></p></li><li><p>All non-alpha characters are removed, with the exception of hyphens (so all periods, commas, ampersands, parentheses, etc., are stripped).<ul><li><p><code>using security.json with solr</code> becomes <code>using security json with solr</code></p></li></ul></p></li><li><p>All whitespaces are replaced with hyphens.<ul><li><p><code>using security json with solr</code> becomes <code>using-security-json-with-solr</code></p></li></ul></p></li></ul></div></div></div>
<div class="dlist"><dl><dt>Example</dt><dd><p>The file <code>schema-api.adoc</code> has a section "Modify the Schema" that looks like this:</p><div class="listingblock"><pre class="rouge highlight"><code><pre class="highlight"><code>== Modify the Schema
`POST /_collection_/schema`</code></pre></code></pre></div>
<p>To link from to this section from another page, you would create a link structured like this:</p>
-<div class="openblock"><div class="content d-flex flex-row"><div class="ulist"><ul><li>the file name of the page with the section (<code>schema-api.adoc</code>),</li><li>then the hash symbol (<code>#</code>),</li><li>then the converted section title (<code>modify-the-schema</code>),</li><li>then a comma and any link title for display.</li></ul></div></div></div>
+<div class="openblock"><div class="content d-flex flex-row"><div class="ulist"><ul><li><p>the file name of the page with the section (<code>schema-api.adoc</code>),</p></li><li><p>then the hash symbol (<code>#</code>),</p></li><li><p>then the converted section title (<code>modify-the-schema</code>),</p></li><li><p>then a comma and any link title for display.</p></li></ul></div></div></div>
<p>The link in context would look like this:</p>
<div class="listingblock"><pre class="rouge highlight"><code><pre class="highlight"><code>For more information, see the section <<schema-api.adoc#modify-the-schema,Modify the Schema>>.</code></pre></code></pre></div></dd></dl></div>
<p>More info: <a class="bare" href="http://asciidoctor.org/docs/user-manual/#inter-document-cross-references">http://asciidoctor.org/docs/user-manual/#inter-document-cross-references</a></p></section></section></section>
<section class="sect2"><h3 id="ordered-and-unordered-lists">Ordered and Unordered Lists</h3><p>AsciiDoc supports three types of lists:</p>
-<div class="ulist"><ul><li>Unordered lists</li><li>Ordered lists</li><li>Labeled lists</li></ul></div>
+<div class="ulist"><ul><li><p>Unordered lists</p></li><li><p>Ordered lists</p></li><li><p>Labeled lists</p></li></ul></div>
<p>Each type of list can be mixed with the other types. So, you could have an ordered list inside a labeled list if necessary.</p>
<section class="sect3"><h4 id="unordered-lists">Unordered Lists</h4><p>Simple bulleted lists need each line to start with an asterisk (<code>*</code>). It should be the first character of the line, and be followed by a space.</p>
<p>These lists also need to be separated from the</p>
@@ -1841,12 +1836,12 @@ We prefer this style of list for paramet
| col 1 row 2 | col 2 row 2|
|===</code></pre></code></pre></div>
<p>Many more examples of formatting:</p>
-<div class="ulist"><ul><li>Columns: <a class="bare" href="http://asciidoctor.org/docs/user-manual/#cols-format">http://asciidoctor.org/docs/user-manual/#cols-format</a></li><li>Cells: <a class="bare" href="http://asciidoctor.org/docs/user-manual/#cell">http://asciidoctor.org/docs/user-manual/#cell</a></li></ul></div></section>
+<div class="ulist"><ul><li><p>Columns: <a class="bare" href="http://asciidoctor.org/docs/user-manual/#cols-format">http://asciidoctor.org/docs/user-manual/#cols-format</a></p></li><li><p>Cells: <a class="bare" href="http://asciidoctor.org/docs/user-manual/#cell">http://asciidoctor.org/docs/user-manual/#cell</a></p></li></ul></div></section>
<section class="sect3"><h4 id="more-options">More Options</h4><p>Tables can also be given footer rows, borders, and captions. You can determine the width of columns, or the width of the table as a whole.</p>
<p>CSV or DSV can also be used instead of formatting the data in pipes.</p>
<p>More info: <a class="bare" href="http://asciidoctor.org/docs/user-manual/#tables">http://asciidoctor.org/docs/user-manual/#tables</a></p></section></section>
<section class="sect2"><h3 id="admonitions-notes-warnings">Admonitions (Notes, Warnings)</h3><p>AsciiDoc supports several types of callout boxes, called "admonitions":</p>
-<div class="ulist"><ul><li>NOTE</li><li>TIP</li><li>IMPORTANT</li><li>CAUTION</li><li>WARNING</li></ul></div>
+<div class="ulist"><ul><li><p>NOTE</p></li><li><p>TIP</p></li><li><p>IMPORTANT</p></li><li><p>CAUTION</p></li><li><p>WARNING</p></li></ul></div>
<p>It is enough to start a paragraph with one of these words followed by a colon (such as <code>NOTE:</code>). When it is converted to HTML, those sections will be formatted properly - indented from the main text and showing an icon inline.</p>
<p>You can add titles to admonitions by making it an admonition block. The structure of an admonition block is like this:</p>
<div class="listingblock"><pre class="rouge highlight"><code><pre class="highlight"><code>.Title of Note
@@ -1862,7 +1857,7 @@ Text of note
<p>Having some tools in your editor is helpful, though.</p>
<section class="sect3"><h4 id="doc-preview">Doc Preview</h4><p>This allows you to see your document in something close to what it might appear like when output to HTML.</p>
<p>The following information is from <a class="bare" href="http://asciidoctor.org/docs/editing-asciidoc-with-live-preview">http://asciidoctor.org/docs/editing-asciidoc-with-live-preview</a>.</p>
-<div class="ulist"><ul><li>Atom has AsciiDoc Preview, which gives you a panel that updates as you type. There are also a couple of other plugins to support AsciiDoc format and auto-complete.</li><li>There is a Live Preview browser plugin for Chrome, Firefox and Opera which allow you to open your AsciiDoc page in the browser. It will also update as you type.</li><li>There is also an Intellij IDEA plugin to support AsciiDoc format.</li></ul></div></section></section></section>
+<div class="ulist"><ul><li><p>Atom has AsciiDoc Preview, which gives you a panel that updates as you type. There are also a couple of other plugins to support AsciiDoc format and auto-complete.</p></li><li><p>There is a Live Preview browser plugin for Chrome, Firefox and Opera which allow you to open your AsciiDoc page in the browser. It will also update as you type.</p></li><li><p>There is also an Intellij IDEA plugin to support AsciiDoc format.</p></li></ul></div></section></section></section>
<section class="sect1"><h2 id="working-with-html-templates">Working with HTML Templates</h2><p>The Solr Ref Guide uses Jekyll to build the HTML version of the site.</p>
<section class="sect2"><h3 id="what-is-jekyll">What is Jekyll?</h3><p>Jekyll is a static site generator, meaning that it takes some set of documents and produces HTML pages. It allows for templating of the pages, so each page has the same look and feel without having to code headers, footers, logos, etc., into every page.</p>
<p>Jekyll is an open source project written in Ruby, online at <a class="bare" href="https://jekyllrb.com/">https://jekyllrb.com/</a>.</p></section>
@@ -1875,7 +1870,7 @@ Text of note
<p>Every document that will be converted to HTML <strong>must</strong> include at least the page title at the top of the page. Page titles are defined with a single equal sign (<code>=</code>) followed by the title that will appear at the top of the page (such as <code>= Topic of the Page</code>).</p>
<p>Many guides to Jekyll also say that defining the <code>layout</code> in the front matter is required. However, since we only use one layout for all pages, we have defined this as a default.</p>
<p>The Solr Ref Guide uses the front matter to define some custom attributes on a per-page basis:</p>
-<div class="ulist"><ul><li><code>page-children</code> - ordered list of child pages, this is used to build the site navigation menu that appears to the left of each page’s content.</li></ul></div>
+<div class="ulist"><ul><li><p><code>page-children</code> - ordered list of child pages, this is used to build the site navigation menu that appears to the left of each page’s content.</p></li></ul></div>
<p>Other page-level elements can also be defined, such as an Asciidoctor attribute that should apply only to that page, but are not needed on a regular basis.</p>
<p>The format for adding any parameter to the front matter is to use colons on both sides of the parameter, followed by the value for the parameter (such as <code>:page-toc: false</code>).</p>
<section class="sect4"><h5 id="table-of-contents">Table of Contents</h5><p>There are some optional custom attributes that can be defined in pages to affect the Table of Contents presentation in Jekyll:</p>
@@ -1968,7 +1963,7 @@ My content...
<section class="sect1"><h2 id="ref-guide-publication-process">Ref Guide Publication Process</h2><p>This section details how to build the Guide for publication.</p>
<section class="sect2"><h3 id="guide-publication-overview">Guide Publication Overview</h3><div class="olist arabic"><ol class="arabic"><li>Build and publish the DRAFT version.</li><li>Continue to update docs as needed while Lucene/Solr artifact VOTE thread is ongoing.</li><li>After VOTE has passed, build and publish final version to overwrite DRAFT watermarked pages.</li></ol></div></section>
<section class="sect2"><h3 id="pre-requisites">Pre-Requisites</h3><p>In order to build the Ref Guide, you must have the following:</p>
-<div class="ulist"><ul><li>You have checked out the Lucene/Solr source code on the machine you will be doing the release from.</li><li>You have Subversion installed. This is needed for committing the HTML files to the production website repo.</li><li>You have installed Ruby and several gems described in the README file located at <code>solr/solr-ref-guide/README.adoc</code> in your Lucene/Solr checkout.</li><li>All builds must be done from the release branch the Guide is for.</li></ul></div>
+<div class="ulist"><ul><li><p>You have checked out the Lucene/Solr source code on the machine you will be doing the release from.</p></li><li><p>You have Subversion installed. This is needed for committing the HTML files to the production website repo.</p></li><li><p>You have installed Ruby and several gems described in the README file located at <code>solr/solr-ref-guide/README.adoc</code> in your Lucene/Solr checkout.</p></li><li><p>All builds must be done from the release branch the Guide is for.</p></li></ul></div>
<div class="admonitionblock note">
<table>
<tr>
@@ -2009,7 +2004,7 @@ The <code>-Dsolr-guide-version</code> sy
</div>
<p><strong>Pull Production Repo and Upload New Files</strong></p>
<div class="olist arabic"><ol class="arabic"><li><p>Checkout the directory you need to update from the svn production repo:</p><div class="listingblock"><pre class="rouge highlight"><code class="language-bash" data-lang="bash"><pre class="highlight"><code><span style="color: #555555">$ </span>svn co https://svn.apache.org/repos/infra/websites/production/lucene/content/solr/guide/<dir></code></pre></code></pre></div>
-<ul><li>This command checks out the Guide version directory into a local subdirectory with the same name as the version (such as "7_7"). You can provide a better name locally if you prefer by adding it to the end of the command shown above.</li><li>Don’t shortcut this and download the whole production website. It will take an incredibly long time and that will feel like <em>forever</em>.</li></ul></li><li>Copy the files from the build location to the checked out Guide directory. For example, if we needed to replace the Guide for Solr 7.7, we’d do <code>cp -r ./solr/build/solr-ref-guide/html-site 7_7/.</code></li><li>Use <code>svn status</code> to see the files modified. If there are any pages added or deleted, use <code>svn add <file></code> or <code>svn rm <file></code> as needed.</li><li>Commit the changes: <code>svn commit -m "Update production 7.7 Ref Guide"</code></li></ol></div>
+<ul><li><p>This command checks out the Guide version directory into a local subdirectory with the same name as the version (such as "7_7"). You can provide a better name locally if you prefer by adding it to the end of the command shown above.</p></li><li><p>Don’t shortcut this and download the whole production website. It will take an incredibly long time and that will feel like <em>forever</em>.</p></li></ul></li><li>Copy the files from the build location to the checked out Guide directory. For example, if we needed to replace the Guide for Solr 7.7, we’d do <code>cp -r ./solr/build/solr-ref-guide/html-site 7_7/.</code></li><li>Use <code>svn status</code> to see the files modified. If there are any pages added or deleted, use <code>svn add <file></code> or <code>svn rm <file></code> as needed.</li><li>Commit the changes: <code>svn commit -m "Update production 7.7 Ref Guide"</code></li></ol></div>
<p><strong>Verify Upload Successful</strong></p>
<p>Spot-check a few pages to verify that the DRAFT watermark is gone, and also
that Solr Javadocs link back to Lucene’s correctly (the UpdateRequestProcessor
@@ -2048,7 +2043,7 @@ The <code>-Dsolr-guide-version</code> sy
<div class="row">
<div class="col-lg-12 footer">
©2020 Apache Software Foundation. All rights reserved. <br />
- Site Version: 8.6-DRAFT <br />Site last generated: 2020-07-08 <br />
+ Site Version: 8.6 <br />Site last generated: 2020-07-15 <br />
<p><img src="images/solr-sunOnly-small.png" alt="Apache Solr"/></p>
</div>
</div>
Modified: websites/production/lucene/content/solr/guide/8_6/implicit-requesthandlers.html
==============================================================================
--- websites/production/lucene/content/solr/guide/8_6/implicit-requesthandlers.html (original)
+++ websites/production/lucene/content/solr/guide/8_6/implicit-requesthandlers.html Wed Jul 15 16:52:36 2020
@@ -8,7 +8,7 @@
<meta name="description" content="">
<meta name="keywords" content=" ">
-<title>Implicit RequestHandlers | Apache Solr Reference Guide 8.6-DRAFT</title>
+<title>Implicit RequestHandlers | Apache Solr Reference Guide 8.6</title>
<link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.1.3/css/bootstrap.min.css" integrity="sha384-MCw98/SFnGE8fJT3GXwEOngsV7Zt27NXFoaoApmYm81iuXoPkFOJwJ8ERdknLPMO" crossorigin="anonymous">
<link rel="stylesheet" type="text/css" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.5.0/css/font-awesome.min.css">
@@ -71,7 +71,7 @@
</script>
</head>
-<body class="DRAFT" id="implicit-requesthandlers">
+<body class="" id="implicit-requesthandlers">
<div class="container-fluid">
<div class="row">
<nav id="sidebar" class="col-2 d-none d-md-block">
@@ -79,11 +79,6 @@
<div class="sidebar-header">
<div class="sidebarTitle text-center">Apache Solr Reference Guide</div>
- <p class="draft-notice">
- This is an unofficial DRAFT of the Guide for 8.6.
- <a href="https://lucene.apache.org/solr/guide/">Official releases are available from the Solr website</a>.
- </p>
-
<!--comment out this block if you want to hide search-->
<!--start search-->
@@ -1772,7 +1767,7 @@ All endpoint paths listed below should b
<div class="row">
<div class="col-lg-12 footer">
©2020 Apache Software Foundation. All rights reserved. <br />
- Site Version: 8.6-DRAFT <br />Site last generated: 2020-07-08 <br />
+ Site Version: 8.6 <br />Site last generated: 2020-07-15 <br />
<p><img src="images/solr-sunOnly-small.png" alt="Apache Solr"/></p>
</div>
</div>
Modified: websites/production/lucene/content/solr/guide/8_6/index-replication.html
==============================================================================
--- websites/production/lucene/content/solr/guide/8_6/index-replication.html (original)
+++ websites/production/lucene/content/solr/guide/8_6/index-replication.html Wed Jul 15 16:52:36 2020
@@ -8,7 +8,7 @@
<meta name="description" content="">
<meta name="keywords" content=" ">
-<title>Index Replication | Apache Solr Reference Guide 8.6-DRAFT</title>
+<title>Index Replication | Apache Solr Reference Guide 8.6</title>
<link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.1.3/css/bootstrap.min.css" integrity="sha384-MCw98/SFnGE8fJT3GXwEOngsV7Zt27NXFoaoApmYm81iuXoPkFOJwJ8ERdknLPMO" crossorigin="anonymous">
<link rel="stylesheet" type="text/css" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.5.0/css/font-awesome.min.css">
@@ -71,7 +71,7 @@
</script>
</head>
-<body class="DRAFT" id="index-replication">
+<body class="" id="index-replication">
<div class="container-fluid">
<div class="row">
<nav id="sidebar" class="col-2 d-none d-md-block">
@@ -79,11 +79,6 @@
<div class="sidebar-header">
<div class="sidebarTitle text-center">Apache Solr Reference Guide</div>
- <p class="draft-notice">
- This is an unofficial DRAFT of the Guide for 8.6.
- <a href="https://lucene.apache.org/solr/guide/">Official releases are available from the Solr website</a>.
- </p>
-
<!--comment out this block if you want to hide search-->
<!--start search-->
@@ -1680,7 +1675,7 @@
<figure class="imageblock"><img src="images/index-replication/worddav2b7e14725d898b4104cdd9c502fc77cd.png" alt="image" width="159" height="235">
<figcaption>Figure 1. A Solr index can be replicated across multiple slave servers, which then process requests.</figcaption></figure></section>
<section class="sect1"><h2 id="index-replication-in-solr">Index Replication in Solr</h2><p>Solr includes a Java implementation of index replication that works over HTTP:</p>
-<div class="ulist"><ul><li>The configuration affecting replication is controlled by a single file, <code>solrconfig.xml</code></li><li>Supports the replication of configuration files as well as index files</li><li>Works across platforms with same configuration</li><li>No reliance on OS-dependent file system features (e.g., hard links)</li><li>Tightly integrated with Solr; an admin page offers fine-grained control of each aspect of replication</li><li>The Java-based replication feature is implemented as a request handler. Configuring replication is therefore similar to any normal request handler.</li></ul></div>
+<div class="ulist"><ul><li><p>The configuration affecting replication is controlled by a single file, <code>solrconfig.xml</code></p></li><li><p>Supports the replication of configuration files as well as index files</p></li><li><p>Works across platforms with same configuration</p></li><li><p>No reliance on OS-dependent file system features (e.g., hard links)</p></li><li><p>Tightly integrated with Solr; an admin page offers fine-grained control of each aspect of replication</p></li><li><p>The Java-based replication feature is implemented as a request handler. Configuring replication is therefore similar to any normal request handler.</p></li></ul></div>
<div class="admonitionblock note">
<table>
<tr>
@@ -1711,7 +1706,7 @@ optimizing is not recommended unless it
</div>
<div class="dlist"><dl><dt>Segments</dt><dd>A self contained subset of an index consisting of some documents and data structures related to the inverted index of terms in those documents.</dd><dt>mergeFactor</dt><dd>A parameter that controls the number of segments in an index. For example, when mergeFactor is set to 3, Solr will fill one segment with documents until the limit maxBufferedDocs is met, then it will start a new segment. When the number of segments specified by mergeFactor is reached (in this example, 3) then Solr will merge all the segments into a single index file, then begin writing new documents to a new segment.</dd><dt>Snapshot</dt><dd>A directory containing hard links to the data files of an index. Snapshots are distributed from the master nodes when the slaves pull them, "smart copying" any segments the slave node does not have in snapshot directory that contains the hard links to the most recent index data files.</dd></dl></div></section>
<section class="sect1"><h2 id="configuring-the-replicationhandler">Configuring the ReplicationHandler</h2><p>In addition to <code>ReplicationHandler</code> configuration options specific to the master/slave roles, there are a few special configuration options that are generally supported (even when using SolrCloud).</p>
-<div class="ulist"><ul><li><code>maxNumberOfBackups</code> an integer value dictating the maximum number of backups this node will keep on disk as it receives <code>backup</code> commands.</li><li>Similar to most other request handlers in Solr you may configure a set of <a href="requesthandlers-and-searchcomponents-in-solrconfig.html#searchhandlers">defaults, invariants, and/or appends</a> parameters corresponding with any request parameters supported by the <code>ReplicationHandler</code> when <a href="#http-api-commands-for-the-replicationhandler">processing commands</a>.</li></ul></div>
+<div class="ulist"><ul><li><p><code>maxNumberOfBackups</code> an integer value dictating the maximum number of backups this node will keep on disk as it receives <code>backup</code> commands.</p></li><li><p>Similar to most other request handlers in Solr you may configure a set of <a href="requesthandlers-and-searchcomponents-in-solrconfig.html#searchhandlers">defaults, invariants, and/or appends</a> parameters corresponding with any request parameters supported by the <code>ReplicationHandler</code> when <a href="#http-api-commands-for-the-replicationhandler">processing commands</a>.</p></li></ul></div>
<section class="sect2"><h3 id="configuring-the-replication-requesthandler-on-a-master-server">Configuring the Replication RequestHandler on a Master Server</h3><p>Before running a replication, you should set the following parameters on initialization of the handler:</p>
<div class="dlist"><dl><dt><code>replicateAfter</code></dt><dd>String specifying action after which replication should occur. Valid values are commit, optimize, or startup. There can be multiple values for this parameter. If you use "startup", you need to have a "commit" and/or "optimize" entry also if you want to trigger replication on future commits or optimizes.</dd><dt><code>backupAfter</code></dt><dd>String specifying action after which a backup should occur. Valid values are commit, optimize, or startup. There can be multiple values for this parameter. It is not required for replication, it just makes a backup.</dd><dt><code>maxNumberOfBackups</code></dt><dd>Integer specifying how many backups to keep. This can be used to delete all but the most recent N backups.</dd><dt><code>confFiles</code></dt><dd>The configuration files to replicate, separated by a comma.</dd><dt><code>commitReserveDuration</code></dt><dd>If your commits are very frequent and your network is slow, you can
tweak this parameter to increase the amount of time expected to be required to transfer data. The default is <code>00:00:10</code> i.e., 10 seconds.</dd></dl></div>
<p>The example below shows a possible 'master' configuration for the <code>ReplicationHandler</code>, including a fixed number of backups and an invariant setting for the <code>maxWriteMBPerSec</code> request parameter to prevent slaves from saturating its network interface</p>
@@ -1772,7 +1767,7 @@ optimizing is not recommended unless it
<span style="color: #000080"></lst></span>
<span style="color: #000080"></requestHandler></span></code></pre></code></pre></div></section></section>
<section class="sect1"><h2 id="setting-up-a-repeater-with-the-replicationhandler">Setting Up a Repeater with the ReplicationHandler</h2><p>A master may be able to serve only so many slaves without affecting performance. Some organizations have deployed slave servers across multiple data centers. If each slave downloads the index from a remote data center, the resulting download may consume too much network bandwidth. To avoid performance degradation in cases like this, you can configure one or more slaves as repeaters. A repeater is simply a node that acts as both a master and a slave.</p>
-<div class="ulist"><ul><li>To configure a server as a repeater, the definition of the Replication <code>requestHandler</code> in the <code>solrconfig.xml</code> file must include file lists of use for both masters and slaves.</li><li>Be sure to set the <code>replicateAfter</code> parameter to commit, even if <code>replicateAfter</code> is set to optimize on the main master. This is because on a repeater (or any slave), a commit is called only after the index is downloaded. The optimize command is never called on slaves.</li><li>Optionally, one can configure the repeater to fetch compressed files from the master through the compression parameter to reduce the index download time.</li></ul></div>
+<div class="ulist"><ul><li><p>To configure a server as a repeater, the definition of the Replication <code>requestHandler</code> in the <code>solrconfig.xml</code> file must include file lists of use for both masters and slaves.</p></li><li><p>Be sure to set the <code>replicateAfter</code> parameter to commit, even if <code>replicateAfter</code> is set to optimize on the main master. This is because on a repeater (or any slave), a commit is called only after the index is downloaded. The optimize command is never called on slaves.</p></li><li><p>Optionally, one can configure the repeater to fetch compressed files from the master through the compression parameter to reduce the index download time.</p></li></ul></div>
<p>Here is an example of a ReplicationHandler configuration for a repeater:</p>
<div class="listingblock"><pre class="rouge highlight"><code class="language-xml" data-lang="xml"><pre class="highlight"><code><span style="color: #000080"><requestHandler</span> <span style="color: #008080">name=</span><span style="color: #d14">"/replication"</span> <span style="color: #008080">class=</span><span style="color: #d14">"solr.ReplicationHandler"</span><span style="color: #000080">></span>
<span style="color: #000080"><lst</span> <span style="color: #008080">name=</span><span style="color: #d14">"master"</span><span style="color: #000080">></span>
@@ -1786,14 +1781,14 @@ optimizing is not recommended unless it
<span style="color: #000080"></requestHandler></span></code></pre></code></pre></div></section>
<section class="sect1"><h2 id="commit-and-optimize-operations">Commit and Optimize Operations</h2><p>When a commit or optimize operation is performed on the master, the RequestHandler reads the list of file names which are associated with each commit point. This relies on the <code>replicateAfter</code> parameter in the configuration to decide which types of events should trigger replication.</p>
<p>These operations are supported:</p>
-<div class="ulist"><ul><li><code>commit</code>: Triggers replication whenever a commit is performed on the master index.</li><li><code>optimize</code>: Triggers replication whenever the master index is optimized.</li><li><code>startup</code>: Triggers replication whenever the master index starts up.</li></ul></div>
+<div class="ulist"><ul><li><p><code>commit</code>: Triggers replication whenever a commit is performed on the master index.</p></li><li><p><code>optimize</code>: Triggers replication whenever the master index is optimized.</p></li><li><p><code>startup</code>: Triggers replication whenever the master index starts up.</p></li></ul></div>
<p>The <code>replicateAfter</code> parameter can accept multiple arguments. For example:</p>
<div class="listingblock"><pre class="rouge highlight"><code class="language-xml" data-lang="xml"><pre class="highlight"><code><span style="color: #000080"><str</span> <span style="color: #008080">name=</span><span style="color: #d14">"replicateAfter"</span><span style="color: #000080">></span>startup<span style="color: #000080"></str></span>
<span style="color: #000080"><str</span> <span style="color: #008080">name=</span><span style="color: #d14">"replicateAfter"</span><span style="color: #000080">></span>commit<span style="color: #000080"></str></span>
<span style="color: #000080"><str</span> <span style="color: #008080">name=</span><span style="color: #d14">"replicateAfter"</span><span style="color: #000080">></span>optimize<span style="color: #000080"></str></span></code></pre></code></pre></div></section>
<section class="sect1"><h2 id="slave-replication">Slave Replication</h2><p>The master is totally unaware of the slaves.</p>
<p>The slave continuously keeps polling the master (depending on the <code>pollInterval</code> parameter) to check the current index version of the master. If the slave finds out that the master has a newer version of the index it initiates a replication process. The steps are as follows:</p>
-<div class="ulist"><ul><li>The slave issues a <code>filelist</code> command to get the list of the files. This command returns the names of the files as well as some metadata (for example, size, a lastmodified timestamp, an alias if any).</li><li>The slave checks with its own index if it has any of those files in the local index. It then runs the filecontent command to download the missing files. This uses a custom format (akin to the HTTP chunked encoding) to download the full content or a part of each file. If the connection breaks in between, the download resumes from the point it failed. At any point, the slave tries 5 times before giving up a replication altogether.</li><li>The files are downloaded into a temp directory, so that if either the slave or the master crashes during the download process, no files will be corrupted. Instead, the current replication will simply abort.</li><li>After the download completes, all the new files are moved to the live index directory and the
file’s timestamp is same as its counterpart on the master.</li><li>A commit command is issued on the slave by the Slave’s ReplicationHandler and the new index is loaded.</li></ul></div>
+<div class="ulist"><ul><li><p>The slave issues a <code>filelist</code> command to get the list of the files. This command returns the names of the files as well as some metadata (for example, size, a lastmodified timestamp, an alias if any).</p></li><li><p>The slave checks with its own index if it has any of those files in the local index. It then runs the filecontent command to download the missing files. This uses a custom format (akin to the HTTP chunked encoding) to download the full content or a part of each file. If the connection breaks in between, the download resumes from the point it failed. At any point, the slave tries 5 times before giving up a replication altogether.</p></li><li><p>The files are downloaded into a temp directory, so that if either the slave or the master crashes during the download process, no files will be corrupted. Instead, the current replication will simply abort.</p></li><li><p>After the download completes, all the new files are moved to the live
index directory and the file’s timestamp is same as its counterpart on the master.</p></li><li><p>A commit command is issued on the slave by the Slave’s ReplicationHandler and the new index is loaded.</p></li></ul></div>
<section class="sect2"><h3 id="replicating-configuration-files">Replicating Configuration Files</h3><p>To replicate configuration files, list them using using the <code>confFiles</code> parameter. Only files found in the <code>conf</code> directory of the master’s Solr instance will be replicated.</p>
<p>Solr replicates configuration files only when the index itself is replicated. That means even if a configuration file is changed on the master, that file will be replicated only after there is a new commit/optimize on master’s index.</p>
<p>Unlike the index files, where the timestamp is good enough to figure out if they are identical, configuration files are compared against their checksum. The <code>schema.xml</code> files (on master and slave) are judged to be identical if their checksums are identical.</p>
@@ -1807,13 +1802,13 @@ optimizing is not recommended unless it
<p>If you like, you can pass an extra attribute such as <code>masterUrl</code> or <code>compression</code> (or any other parameter which is specified in the <code><lst name="slave"></code> tag) to do a one time replication from a master. This obviates the need for hard-coding the master in the slave.</p></dd><dt><code>abortfetch</code></dt><dd><p>Abort copying an index from a master to the specified slave.</p><div class="listingblock"><pre class="rouge highlight"><code class="language-bash" data-lang="bash"><pre class="highlight"><code>http://_slave_host:port_/solr/_core_name_/replication?command<span style="color: #000000;font-weight: bold">=</span>abortfetch</code></pre></code></pre></div></dd><dt><code>enablepoll</code></dt><dd><p>Enable the specified slave to poll for changes on the master.</p><div class="listingblock"><pre class="rouge highlight"><code class="language-bash" data-lang="bash"><pre class="highlight"><code>http://_slave_host:port_/solr/_core_name_/replication
?command<span style="color: #000000;font-weight: bold">=</span>enablepoll</code></pre></code></pre></div></dd><dt><code>disablepoll</code></dt><dd><p>Disable the specified slave from polling for changes on the master.</p><div class="listingblock"><pre class="rouge highlight"><code class="language-bash" data-lang="bash"><pre class="highlight"><code>http://_slave_host:port_/solr/_core_name_/replication?command<span style="color: #000000;font-weight: bold">=</span>disablepoll</code></pre></code></pre></div></dd><dt><code>details</code></dt><dd><p>Retrieve configuration details and current status.</p><div class="listingblock"><pre class="rouge highlight"><code class="language-bash" data-lang="bash"><pre class="highlight"><code>http://_slave_host:port_/solr/_core_name_/replication?command<span style="color: #000000;font-weight: bold">=</span>details</code></pre></code></pre></div></dd><dt><code>filelist</code></dt><dd><p>Retrieve a list of Lucene files present in the specified host’
;s index.</p><div class="listingblock"><pre class="rouge highlight"><code class="language-bash" data-lang="bash"><pre class="highlight"><code>http://_host:port_/solr/_core_name_/replication?command<span style="color: #000000;font-weight: bold">=</span>filelist&generation<span style="color: #000000;font-weight: bold">=</span><_generation-number_></code></pre></code></pre></div>
<p>You can discover the generation number of the index by running the <code>indexversion</code> command.</p></dd><dt><code>backup</code></dt><dd><p>Create a backup on master if there are committed index data in the server; otherwise, does nothing.</p><div class="listingblock"><pre class="rouge highlight"><code class="language-bash" data-lang="bash"><pre class="highlight"><code>http://_master_host:port_/solr/_core_name_/replication?command<span style="color: #000000;font-weight: bold">=</span>backup</code></pre></code></pre></div>
<p>This command is useful for making periodic backups. There are several supported request parameters:</p>
-<ul><li><code>numberToKeep:</code>: This can be used with the backup command unless the <code>maxNumberOfBackups</code> initialization parameter has been specified on the handler â in which case <code>maxNumberOfBackups</code> is always used and attempts to use the <code>numberToKeep</code> request parameter will cause an error.</li><li><code>name</code>: (optional) Backup name. The snapshot will be created in a directory called <code>snapshot.<name></code> within the data directory of the core. By default the name is generated using date in <code>yyyyMMddHHmmssSSS</code> format. If <code>location</code> parameter is passed, that would be used instead of the data directory</li><li><code>repository</code>: The name of the backup repository to use. When not specified, it defaults to local file system.</li><li><code>location</code>: Backup location. Value depends on the repository in use. For file system repository, location defaults to core’s dataDir, and if specified
, it needs to be within <code>SOLR_HOME</code>, <code>SOLR_DATA_HOME</code> or the paths specified by solr.xml <code>allowPaths</code>.</li></ul></dd><dt><code>restore</code></dt><dd><p>Restore a backup from a backup repository.</p><div class="listingblock"><pre class="rouge highlight"><code class="language-bash" data-lang="bash"><pre class="highlight"><code>http://_master_host:port_/solr/_core_name_/replication?command<span style="color: #000000;font-weight: bold">=</span>restore</code></pre></code></pre></div>
+<ul><li><p><code>numberToKeep:</code>: This can be used with the backup command unless the <code>maxNumberOfBackups</code> initialization parameter has been specified on the handler â in which case <code>maxNumberOfBackups</code> is always used and attempts to use the <code>numberToKeep</code> request parameter will cause an error.</p></li><li><p><code>name</code>: (optional) Backup name. The snapshot will be created in a directory called <code>snapshot.<name></code> within the data directory of the core. By default the name is generated using date in <code>yyyyMMddHHmmssSSS</code> format. If <code>location</code> parameter is passed, that would be used instead of the data directory</p></li><li><p><code>repository</code>: The name of the backup repository to use. When not specified, it defaults to local file system.</p></li><li><p><code>location</code>: Backup location. Value depends on the repository in use. For file system repository, location defaults to core’s d
ataDir, and if specified, it needs to be within <code>SOLR_HOME</code>, <code>SOLR_DATA_HOME</code> or the paths specified by solr.xml <code>allowPaths</code>.</p></li></ul></dd><dt><code>restore</code></dt><dd><p>Restore a backup from a backup repository.</p><div class="listingblock"><pre class="rouge highlight"><code class="language-bash" data-lang="bash"><pre class="highlight"><code>http://_master_host:port_/solr/_core_name_/replication?command<span style="color: #000000;font-weight: bold">=</span>restore</code></pre></code></pre></div>
<p>This command is used to restore a backup. There are several supported request parameters:</p>
-<ul><li><code>name</code>: (optional) Backup name. The name of the backed up index snapshot to be restored. If the name is not provided, it looks for backups with snapshot.<timestamp> format in the location directory. It picks the latest timestamp backup in that case.</li><li><code>repository</code>: The name of the backup repository where the backup resides. When not specified, it defaults to local file system.</li><li><code>location</code>: Backup location. Value depends on the repository in use. For file system repository, location defaults to core’s dataDir, and if specified, it needs to be within <code>SOLR_HOME</code>, <code>SOLR_DATA_HOME</code> or the paths specified by solr.xml <code>allowPaths</code>.</li></ul></dd><dt><code>restorestatus</code></dt><dd><p>Check the status of a running restore operation.</p><div class="listingblock"><pre class="rouge highlight"><code class="language-bash" data-lang="bash"><pre class="highlight"><code>http://_master_host:port_/s
olr/_core_name_/replication?command<span style="color: #000000;font-weight: bold">=</span>restorestatus</code></pre></code></pre></div>
+<ul><li><p><code>name</code>: (optional) Backup name. The name of the backed up index snapshot to be restored. If the name is not provided, it looks for backups with snapshot.<timestamp> format in the location directory. It picks the latest timestamp backup in that case.</p></li><li><p><code>repository</code>: The name of the backup repository where the backup resides. When not specified, it defaults to local file system.</p></li><li><p><code>location</code>: Backup location. Value depends on the repository in use. For file system repository, location defaults to core’s dataDir, and if specified, it needs to be within <code>SOLR_HOME</code>, <code>SOLR_DATA_HOME</code> or the paths specified by solr.xml <code>allowPaths</code>.</p></li></ul></dd><dt><code>restorestatus</code></dt><dd><p>Check the status of a running restore operation.</p><div class="listingblock"><pre class="rouge highlight"><code class="language-bash" data-lang="bash"><pre class="highlight"><code>http:/
/_master_host:port_/solr/_core_name_/replication?command<span style="color: #000000;font-weight: bold">=</span>restorestatus</code></pre></code></pre></div>
<p>This command is used to check the status of a restore operation. This command takes no parameters.</p>
<p>The status value can be "In Progress" , "success" or "failed". If it failed then an "exception" will also be sent in the response.</p></dd><dt><code>deletebackup</code></dt><dd><p>Delete any backup created using the <code>backup</code> command.</p><div class="listingblock"><pre class="rouge highlight"><code class="language-bash" data-lang="bash"><pre class="highlight"><code>http://_master_host:port_ /solr/_core_name_/replication?command<span style="color: #000000;font-weight: bold">=</span>deletebackup</code></pre></code></pre></div>
<p>There are two supported parameters:</p>
-<ul><li><code>name</code>: The name of the snapshot. A snapshot with the name <code>snapshot.<em>name</em></code> must exist. If not, an error is thrown.</li><li><code>location</code>: Location where the snapshot is created.</li></ul></dd></dl></div></section>
+<ul><li><p><code>name</code>: The name of the snapshot. A snapshot with the name <code>snapshot.<em>name</em></code> must exist. If not, an error is thrown.</p></li><li><p><code>location</code>: Location where the snapshot is created.</p></li></ul></dd></dl></div></section>
<section class="sect1"><h2 id="distribution-and-optimization">Distribution and Optimization</h2><p>Optimizing an index is not something most users should generally worry about - but in particular users should be aware of the impacts of optimizing an index when using the <code>ReplicationHandler</code>.</p>
<p>The time required to optimize a master index can vary dramatically. A small index may be optimized in minutes. A very large index may take hours. The variables include the size of the index and the speed of the hardware.</p>
<p>Distributing a newly optimized index may take only a few minutes or up to an hour or more, again depending on the size of the index and the performance capabilities of network connections and disks. During optimization the machine is under load and does not process queries very well. Given a schedule of updates being driven a few times an hour to the slaves, we cannot run an optimize with every committed snapshot.</p>
@@ -1862,7 +1857,7 @@ Do not elect to optimize your index unle
<div class="row">
<div class="col-lg-12 footer">
©2020 Apache Software Foundation. All rights reserved. <br />
- Site Version: 8.6-DRAFT <br />Site last generated: 2020-07-08 <br />
+ Site Version: 8.6 <br />Site last generated: 2020-07-15 <br />
<p><img src="images/solr-sunOnly-small.png" alt="Apache Solr"/></p>
</div>
</div>
Modified: websites/production/lucene/content/solr/guide/8_6/index.html
==============================================================================
--- websites/production/lucene/content/solr/guide/8_6/index.html (original)
+++ websites/production/lucene/content/solr/guide/8_6/index.html Wed Jul 15 16:52:36 2020
@@ -8,7 +8,7 @@
<meta name="description" content="">
<meta name="keywords" content=" ">
-<title>Apache Solr Reference Guide | Apache Solr Reference Guide 8.6-DRAFT</title>
+<title>Apache Solr Reference Guide | Apache Solr Reference Guide 8.6</title>
<link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.1.3/css/bootstrap.min.css" integrity="sha384-MCw98/SFnGE8fJT3GXwEOngsV7Zt27NXFoaoApmYm81iuXoPkFOJwJ8ERdknLPMO" crossorigin="anonymous">
<link rel="stylesheet" type="text/css" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.5.0/css/font-awesome.min.css">
@@ -71,7 +71,7 @@
</script>
</head>
-<body class="DRAFT" id="">
+<body class="" id="">
<div class="container-fluid">
<div class="row">
<nav id="sidebar" class="col-2 d-none d-md-block">
@@ -79,11 +79,6 @@
<div class="sidebar-header">
<div class="sidebarTitle text-center">Apache Solr Reference Guide</div>
- <p class="draft-notice">
- This is an unofficial DRAFT of the Guide for 8.6.
- <a href="https://lucene.apache.org/solr/guide/">Official releases are available from the Solr website</a>.
- </p>
-
<!--comment out this block if you want to hide search-->
<!--start search-->
@@ -1678,7 +1673,7 @@
<div class="row">
<div class="col-lg-12 footer">
©2020 Apache Software Foundation. All rights reserved. <br />
- Site Version: 8.6-DRAFT <br />Site last generated: 2020-07-08 <br />
+ Site Version: 8.6 <br />Site last generated: 2020-07-15 <br />
<p><img src="images/solr-sunOnly-small.png" alt="Apache Solr"/></p>
</div>
</div>
Modified: websites/production/lucene/content/solr/guide/8_6/indexconfig-in-solrconfig.html
==============================================================================
--- websites/production/lucene/content/solr/guide/8_6/indexconfig-in-solrconfig.html (original)
+++ websites/production/lucene/content/solr/guide/8_6/indexconfig-in-solrconfig.html Wed Jul 15 16:52:36 2020
@@ -8,7 +8,7 @@
<meta name="description" content="">
<meta name="keywords" content=" ">
-<title>IndexConfig in SolrConfig | Apache Solr Reference Guide 8.6-DRAFT</title>
+<title>IndexConfig in SolrConfig | Apache Solr Reference Guide 8.6</title>
<link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.1.3/css/bootstrap.min.css" integrity="sha384-MCw98/SFnGE8fJT3GXwEOngsV7Zt27NXFoaoApmYm81iuXoPkFOJwJ8ERdknLPMO" crossorigin="anonymous">
<link rel="stylesheet" type="text/css" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.5.0/css/font-awesome.min.css">
@@ -71,7 +71,7 @@
</script>
</head>
-<body class="DRAFT" id="indexconfig-in-solrconfig">
+<body class="" id="indexconfig-in-solrconfig">
<div class="container-fluid">
<div class="row">
<nav id="sidebar" class="col-2 d-none d-md-block">
@@ -79,11 +79,6 @@
<div class="sidebar-header">
<div class="sidebarTitle text-center">Apache Solr Reference Guide</div>
- <p class="draft-notice">
- This is an unofficial DRAFT of the Guide for 8.6.
- <a href="https://lucene.apache.org/solr/guide/">Official releases are available from the Solr website</a>.
- </p>
-
<!--comment out this block if you want to hide search-->
<!--start search-->
@@ -1764,7 +1759,7 @@ This is an expert level parameter as it
<section class="sect1"><h2 id="index-locks">Index Locks</h2><section class="sect2"><h3 id="locktype">lockType</h3><p>The LockFactory options specify the locking implementation to use.</p>
<p>The set of valid lock type options depends on the <a href="datadir-and-directoryfactory-in-solrconfig.html#datadir-and-directoryfactory-in-solrconfig">DirectoryFactory</a> you have configured.</p>
<p>The values listed below are are supported by <code>StandardDirectoryFactory</code> (the default):</p>
-<div class="ulist"><ul><li><code>native</code> (default) uses NativeFSLockFactory to specify native OS file locking. If a second Solr process attempts to access the directory, it will fail. Do not use when multiple Solr web applications are attempting to share a single index. See also the <a href="https://lucene.apache.org/core/8_6_0/core/org/apache/lucene/store/NativeFSLockFactory.html">Javadocs</a>.</li><li><code>simple</code> uses SimpleFSLockFactory to specify a plain file for locking. See also the <a href="https://lucene.apache.org/core/8_6_0/core/org/apache/lucene/store/SimpleFSLockFactory.html">Javadocs</a>.</li><li><code>single</code> (expert) uses SingleInstanceLockFactory. Use for special situations of a read-only index directory, or when there is no possibility of more than one process trying to modify the index (even sequentially). This type will protect against multiple cores within the <em>same</em> JVM attempting to access the same index. WARNING! If multiple Solr ins
tances in different JVMs modify an index, this type will <em>not</em> protect against index corruption. See also the <a href="https://lucene.apache.org/core/8_6_0/core/org/apache/lucene/store/SingleInstanceLockFactory.html">Javadocs</a>.</li><li><code>hdfs</code> uses HdfsLockFactory to support reading and writing index and transaction log files to a HDFS filesystem. See the section <a href="running-solr-on-hdfs.html#running-solr-on-hdfs">Running Solr on HDFS</a> for more details on using this feature.</li></ul></div>
+<div class="ulist"><ul><li><p><code>native</code> (default) uses NativeFSLockFactory to specify native OS file locking. If a second Solr process attempts to access the directory, it will fail. Do not use when multiple Solr web applications are attempting to share a single index. See also the <a href="https://lucene.apache.org/core/8_6_0/core/org/apache/lucene/store/NativeFSLockFactory.html">Javadocs</a>.</p></li><li><p><code>simple</code> uses SimpleFSLockFactory to specify a plain file for locking. See also the <a href="https://lucene.apache.org/core/8_6_0/core/org/apache/lucene/store/SimpleFSLockFactory.html">Javadocs</a>.</p></li><li><p><code>single</code> (expert) uses SingleInstanceLockFactory. Use for special situations of a read-only index directory, or when there is no possibility of more than one process trying to modify the index (even sequentially). This type will protect against multiple cores within the <em>same</em> JVM attempting to access the same index. WARNING! If
multiple Solr instances in different JVMs modify an index, this type will <em>not</em> protect against index corruption. See also the <a href="https://lucene.apache.org/core/8_6_0/core/org/apache/lucene/store/SingleInstanceLockFactory.html">Javadocs</a>.</p></li><li><p><code>hdfs</code> uses HdfsLockFactory to support reading and writing index and transaction log files to a HDFS filesystem. See the section <a href="running-solr-on-hdfs.html#running-solr-on-hdfs">Running Solr on HDFS</a> for more details on using this feature.</p></li></ul></div>
<div class="listingblock"><pre class="rouge highlight"><code class="language-xml" data-lang="xml"><pre class="highlight"><code><span style="color: #000080"><lockType></span>native<span style="color: #000080"></lockType></span></code></pre></code></pre></div></section>
<section class="sect2"><h3 id="writelocktimeout">writeLockTimeout</h3><p>The maximum time to wait for a write lock on an IndexWriter. The default is 1000, expressed in milliseconds.</p>
<div class="listingblock"><pre class="rouge highlight"><code class="language-xml" data-lang="xml"><pre class="highlight"><code><span style="color: #000080"><writeLockTimeout></span>1000<span style="color: #000080"></writeLockTimeout></span></code></pre></code></pre></div></section></section>
@@ -1805,7 +1800,7 @@ This is an expert level parameter as it
<div class="row">
<div class="col-lg-12 footer">
©2020 Apache Software Foundation. All rights reserved. <br />
- Site Version: 8.6-DRAFT <br />Site last generated: 2020-07-08 <br />
+ Site Version: 8.6 <br />Site last generated: 2020-07-15 <br />
<p><img src="images/solr-sunOnly-small.png" alt="Apache Solr"/></p>
</div>
</div>
Modified: websites/production/lucene/content/solr/guide/8_6/indexing-and-basic-data-operations.html
==============================================================================
--- websites/production/lucene/content/solr/guide/8_6/indexing-and-basic-data-operations.html (original)
+++ websites/production/lucene/content/solr/guide/8_6/indexing-and-basic-data-operations.html Wed Jul 15 16:52:36 2020
@@ -8,7 +8,7 @@
<meta name="description" content="">
<meta name="keywords" content=" ">
-<title>Indexing and Basic Data Operations | Apache Solr Reference Guide 8.6-DRAFT</title>
+<title>Indexing and Basic Data Operations | Apache Solr Reference Guide 8.6</title>
<link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.1.3/css/bootstrap.min.css" integrity="sha384-MCw98/SFnGE8fJT3GXwEOngsV7Zt27NXFoaoApmYm81iuXoPkFOJwJ8ERdknLPMO" crossorigin="anonymous">
<link rel="stylesheet" type="text/css" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.5.0/css/font-awesome.min.css">
@@ -71,7 +71,7 @@
</script>
</head>
-<body class="DRAFT" id="indexing-and-basic-data-operations">
+<body class="" id="indexing-and-basic-data-operations">
<div class="container-fluid">
<div class="row">
<nav id="sidebar" class="col-2 d-none d-md-block">
@@ -79,11 +79,6 @@
<div class="sidebar-header">
<div class="sidebarTitle text-center">Apache Solr Reference Guide</div>
- <p class="draft-notice">
- This is an unofficial DRAFT of the Guide for 8.6.
- <a href="https://lucene.apache.org/solr/guide/">Official releases are available from the Solr website</a>.
- </p>
-
<!--comment out this block if you want to hide search-->
<!--start search-->
@@ -1659,7 +1654,7 @@
<section class="content">
<section id="preamble" aria-label="Preamble"><p>This section describes how Solr adds data to its index. It covers the following topics:</p>
-<div class="ulist"><ul><li><strong><a href="introduction-to-solr-indexing.html#introduction-to-solr-indexing">Introduction to Solr Indexing</a></strong>: An overview of Solr’s indexing process.</li><li><strong><a href="post-tool.html#post-tool">Post Tool</a></strong>: Information about using <code>post.jar</code> to quickly upload some content to your system.</li><li><strong><a href="uploading-data-with-index-handlers.html#uploading-data-with-index-handlers">Uploading Data with Index Handlers</a></strong>: Information about using Solr’s Index Handlers to upload XML/XSLT, JSON and CSV data.</li><li><strong><a href="transforming-and-indexing-custom-json.html#transforming-and-indexing-custom-json">Transforming and Indexing Custom JSON</a></strong>: Index any JSON of your choice</li><li><strong><a href="indexing-nested-documents.html#indexing-nested-documents">Indexing Nested Documents</a></strong>: Detailed information about indexing and schema configuration for nested docu
ments.</li><li><strong><a href="uploading-data-with-solr-cell-using-apache-tika.html#uploading-data-with-solr-cell-using-apache-tika">Uploading Data with Solr Cell using Apache Tika</a></strong>: Information about using the Solr Cell framework to upload data for indexing.</li><li><strong><a href="uploading-structured-data-store-data-with-the-data-import-handler.html#uploading-structured-data-store-data-with-the-data-import-handler">Uploading Structured Data Store Data with the Data Import Handler</a></strong>: Information about uploading and indexing data from a structured data store.</li><li><strong><a href="updating-parts-of-documents.html#updating-parts-of-documents">Updating Parts of Documents</a></strong>: Information about how to use atomic updates and optimistic concurrency with Solr.</li><li><strong><a href="detecting-languages-during-indexing.html#detecting-languages-during-indexing">Detecting Languages During Indexing</a></strong>: Information about using language identifi
cation during the indexing process.</li><li><strong><a href="de-duplication.html#de-duplication">De-Duplication</a></strong>: Information about configuring Solr to mark duplicate documents as they are indexed.</li><li><strong><a href="content-streams.html#content-streams">Content Streams</a></strong>: Information about streaming content to Solr Request Handlers.</li><li><strong><a href="reindexing.html#reindexing">Reindexing</a></strong>: Details about when reindexing is required or recommended, and some strategies for completely reindexing your documents.</li></ul></div></section>
+<div class="ulist"><ul><li><p><strong><a href="introduction-to-solr-indexing.html#introduction-to-solr-indexing">Introduction to Solr Indexing</a></strong>: An overview of Solr’s indexing process.</p></li><li><p><strong><a href="post-tool.html#post-tool">Post Tool</a></strong>: Information about using <code>post.jar</code> to quickly upload some content to your system.</p></li><li><p><strong><a href="uploading-data-with-index-handlers.html#uploading-data-with-index-handlers">Uploading Data with Index Handlers</a></strong>: Information about using Solr’s Index Handlers to upload XML/XSLT, JSON and CSV data.</p></li><li><p><strong><a href="transforming-and-indexing-custom-json.html#transforming-and-indexing-custom-json">Transforming and Indexing Custom JSON</a></strong>: Index any JSON of your choice</p></li><li><p><strong><a href="indexing-nested-documents.html#indexing-nested-documents">Indexing Nested Documents</a></strong>: Detailed information about indexing and schem
a configuration for nested documents.</p></li><li><p><strong><a href="uploading-data-with-solr-cell-using-apache-tika.html#uploading-data-with-solr-cell-using-apache-tika">Uploading Data with Solr Cell using Apache Tika</a></strong>: Information about using the Solr Cell framework to upload data for indexing.</p></li><li><p><strong><a href="uploading-structured-data-store-data-with-the-data-import-handler.html#uploading-structured-data-store-data-with-the-data-import-handler">Uploading Structured Data Store Data with the Data Import Handler</a></strong>: Information about uploading and indexing data from a structured data store.</p></li><li><p><strong><a href="updating-parts-of-documents.html#updating-parts-of-documents">Updating Parts of Documents</a></strong>: Information about how to use atomic updates and optimistic concurrency with Solr.</p></li><li><p><strong><a href="detecting-languages-during-indexing.html#detecting-languages-during-indexing">Detecting Languages During Index
ing</a></strong>: Information about using language identification during the indexing process.</p></li><li><p><strong><a href="de-duplication.html#de-duplication">De-Duplication</a></strong>: Information about configuring Solr to mark duplicate documents as they are indexed.</p></li><li><p><strong><a href="content-streams.html#content-streams">Content Streams</a></strong>: Information about streaming content to Solr Request Handlers.</p></li><li><p><strong><a href="reindexing.html#reindexing">Reindexing</a></strong>: Details about when reindexing is required or recommended, and some strategies for completely reindexing your documents.</p></li></ul></div></section>
<section class="sect1"><h2 id="indexing-using-client-apis">Indexing Using Client APIs</h2><p>Using client APIs, such as <a href="using-solrj.html#using-solrj">SolrJ</a>, from your applications is an important option for updating Solr indexes. See the <a href="client-apis.html#client-apis">Client APIs</a> section for more information.</p></section>
</section>
@@ -1690,7 +1685,7 @@
<div class="row">
<div class="col-lg-12 footer">
©2020 Apache Software Foundation. All rights reserved. <br />
- Site Version: 8.6-DRAFT <br />Site last generated: 2020-07-08 <br />
+ Site Version: 8.6 <br />Site last generated: 2020-07-15 <br />
<p><img src="images/solr-sunOnly-small.png" alt="Apache Solr"/></p>
</div>
</div>
Modified: websites/production/lucene/content/solr/guide/8_6/indexing-nested-documents.html
==============================================================================
--- websites/production/lucene/content/solr/guide/8_6/indexing-nested-documents.html (original)
+++ websites/production/lucene/content/solr/guide/8_6/indexing-nested-documents.html Wed Jul 15 16:52:36 2020
@@ -8,7 +8,7 @@
<meta name="description" content="">
<meta name="keywords" content=" ">
-<title>Indexing Nested Child Documents | Apache Solr Reference Guide 8.6-DRAFT</title>
+<title>Indexing Nested Child Documents | Apache Solr Reference Guide 8.6</title>
<link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.1.3/css/bootstrap.min.css" integrity="sha384-MCw98/SFnGE8fJT3GXwEOngsV7Zt27NXFoaoApmYm81iuXoPkFOJwJ8ERdknLPMO" crossorigin="anonymous">
<link rel="stylesheet" type="text/css" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.5.0/css/font-awesome.min.css">
@@ -71,7 +71,7 @@
</script>
</head>
-<body class="DRAFT" id="indexing-nested-documents">
+<body class="" id="indexing-nested-documents">
<div class="container-fluid">
<div class="row">
<nav id="sidebar" class="col-2 d-none d-md-block">
@@ -79,11 +79,6 @@
<div class="sidebar-header">
<div class="sidebarTitle text-center">Apache Solr Reference Guide</div>
- <p class="draft-notice">
- This is an unofficial DRAFT of the Guide for 8.6.
- <a href="https://lucene.apache.org/solr/guide/">Official releases are available from the Solr website</a>.
- </p>
-
<!--comment out this block if you want to hide search-->
<!--start search-->
@@ -1686,15 +1681,15 @@ Nested documents may be indexed via eith
</tr>
</table>
</div></section>
-<section class="sect1"><h2 id="schema-configuration">Schema Configuration</h2><div class="ulist"><ul><li>The schema must include an indexed field <code>_root_</code>. Solr automatically populates this with the value of the top/parent ID.<br>
-<code><field name="_root_" type="string" indexed="true" stored="false" docValues="false" /></code><ul><li><code>_root_</code> must be set either as stored (stored="true") or doc values (docValues="true") to enable
-<a href="updating-parts-of-documents.html#updating-child-documents">atomic updates of nested documents</a>. Also, beware of <code>uniqueBlock(_root_)</code> <a href="json-facet-api.html#stat-facet-functions">field type limitation</a>, if you plan to use one.</li></ul></li><li><code>_nest_path_</code> is populated by Solr automatically with the path of the document in the hierarchy for non-root documents. This field is optional.<br>
+<section class="sect1"><h2 id="schema-configuration">Schema Configuration</h2><div class="ulist"><ul><li><p>The schema must include an indexed field <code>_root_</code>. Solr automatically populates this with the value of the top/parent ID.<br>
+<code><field name="_root_" type="string" indexed="true" stored="false" docValues="false" /></code><ul><li><p><code>_root_</code> must be set either as stored (stored="true") or doc values (docValues="true") to enable
+<a href="updating-parts-of-documents.html#updating-child-documents">atomic updates of nested documents</a>. Also, beware of <code>uniqueBlock(_root_)</code> <a href="json-facet-api.html#stat-facet-functions">field type limitation</a>, if you plan to use one.</p></li></ul></p></li><li><p><code>_nest_path_</code> is populated by Solr automatically with the path of the document in the hierarchy for non-root documents. This field is optional.<br>
<code><fieldType name="_nest_path_" class="solr.NestPathField" />
- <field name="_nest_path_" type="<em>nest_path</em>" /></code></li><li><code>_nest_parent_</code> is populated by Solr automatically to store the ID of each document’s parent document (if there is one). This field is optional.<br>
-<code><field name="_nest_parent_" type="string" indexed="true" stored="true"/></code></li><li>Nested documents are very much documents in their own right even if certain nested documents hold different information from the parent.
-Therefore:<ul><li>a field can only be configured one way no matter what sort of document uses it</li><li>it may be infeasible to use <code>required</code></li><li>even child documents need a unique ID</li></ul></li><li>Even though child documents are provided as field values syntactically and with SolrJ, it’s a matter of syntax and it isn’t an actual field in the schema.
+ <field name="_nest_path_" type="<em>nest_path</em>" /></code></p></li><li><p><code>_nest_parent_</code> is populated by Solr automatically to store the ID of each document’s parent document (if there is one). This field is optional.<br>
+<code><field name="_nest_parent_" type="string" indexed="true" stored="true"/></code></p></li><li><p>Nested documents are very much documents in their own right even if certain nested documents hold different information from the parent.
+Therefore:<ul><li><p>a field can only be configured one way no matter what sort of document uses it</p></li><li><p>it may be infeasible to use <code>required</code></p></li><li><p>even child documents need a unique ID</p></li></ul></p></li><li><p>Even though child documents are provided as field values syntactically and with SolrJ, it’s a matter of syntax and it isn’t an actual field in the schema.
Consequently, the field need not be defined in the schema and probably shouldn’t be as it would be confusing.
-There is no child document field type, at least not yet.</li></ul></div>
+There is no child document field type, at least not yet.</p></li></ul></div>
<section class="sect2"><h3 id="rudimentary-root-only-schemas">Rudimentary Root-only Schemas</h3><p>These schemas do not contain any other nested related fields apart from <code>_root_</code>.
Many schemas in existence are this way simply because default configsets are this way, even if the application isn’t using nested documents.
If an application uses nested documents with such a schema, keep in mind that that some related features aren’t as effective since there is less information. Mainly the <a href="searching-nested-documents.html#child-doc-transformer">[child]</a> transformer returns matching children in a flat list (not nested) and it’s attached to the parent using the special field name <code>_childDocuments_</code>.</p>
@@ -1808,7 +1803,7 @@ If you use Solr’s delete-by-query
<div class="row">
<div class="col-lg-12 footer">
©2020 Apache Software Foundation. All rights reserved. <br />
- Site Version: 8.6-DRAFT <br />Site last generated: 2020-07-08 <br />
+ Site Version: 8.6 <br />Site last generated: 2020-07-15 <br />
<p><img src="images/solr-sunOnly-small.png" alt="Apache Solr"/></p>
</div>
</div>
Modified: websites/production/lucene/content/solr/guide/8_6/indexupgrader-tool.html
==============================================================================
--- websites/production/lucene/content/solr/guide/8_6/indexupgrader-tool.html (original)
+++ websites/production/lucene/content/solr/guide/8_6/indexupgrader-tool.html Wed Jul 15 16:52:36 2020
@@ -8,7 +8,7 @@
<meta name="description" content="">
<meta name="keywords" content=" ">
-<title>IndexUpgraderTool | Apache Solr Reference Guide 8.6-DRAFT</title>
+<title>IndexUpgraderTool | Apache Solr Reference Guide 8.6</title>
<link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.1.3/css/bootstrap.min.css" integrity="sha384-MCw98/SFnGE8fJT3GXwEOngsV7Zt27NXFoaoApmYm81iuXoPkFOJwJ8ERdknLPMO" crossorigin="anonymous">
<link rel="stylesheet" type="text/css" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.5.0/css/font-awesome.min.css">
@@ -71,7 +71,7 @@
</script>
</head>
-<body class="DRAFT" id="indexupgrader-tool">
+<body class="" id="indexupgrader-tool">
<div class="container-fluid">
<div class="row">
<nav id="sidebar" class="col-2 d-none d-md-block">
@@ -79,11 +79,6 @@
<div class="sidebar-header">
<div class="sidebarTitle text-center">Apache Solr Reference Guide</div>
- <p class="draft-notice">
- This is an unofficial DRAFT of the Guide for 8.6.
- <a href="https://lucene.apache.org/solr/guide/">Official releases are available from the Solr website</a>.
- </p>
-
<!--comment out this block if you want to hide search-->
<!--start search-->
@@ -1718,7 +1713,7 @@
<div class="row">
<div class="col-lg-12 footer">
©2020 Apache Software Foundation. All rights reserved. <br />
- Site Version: 8.6-DRAFT <br />Site last generated: 2020-07-08 <br />
+ Site Version: 8.6 <br />Site last generated: 2020-07-15 <br />
<p><img src="images/solr-sunOnly-small.png" alt="Apache Solr"/></p>
</div>
</div>
Modified: websites/production/lucene/content/solr/guide/8_6/initparams-in-solrconfig.html
==============================================================================
--- websites/production/lucene/content/solr/guide/8_6/initparams-in-solrconfig.html (original)
+++ websites/production/lucene/content/solr/guide/8_6/initparams-in-solrconfig.html Wed Jul 15 16:52:36 2020
@@ -8,7 +8,7 @@
<meta name="description" content="">
<meta name="keywords" content=" ">
-<title>InitParams in SolrConfig | Apache Solr Reference Guide 8.6-DRAFT</title>
+<title>InitParams in SolrConfig | Apache Solr Reference Guide 8.6</title>
<link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.1.3/css/bootstrap.min.css" integrity="sha384-MCw98/SFnGE8fJT3GXwEOngsV7Zt27NXFoaoApmYm81iuXoPkFOJwJ8ERdknLPMO" crossorigin="anonymous">
<link rel="stylesheet" type="text/css" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.5.0/css/font-awesome.min.css">
@@ -71,7 +71,7 @@
</script>
</head>
-<body class="DRAFT" id="initparams-in-solrconfig">
+<body class="" id="initparams-in-solrconfig">
<div class="container-fluid">
<div class="row">
<nav id="sidebar" class="col-2 d-none d-md-block">
@@ -79,11 +79,6 @@
<div class="sidebar-header">
<div class="sidebarTitle text-center">Apache Solr Reference Guide</div>
- <p class="draft-notice">
- This is an unofficial DRAFT of the Guide for 8.6.
- <a href="https://lucene.apache.org/solr/guide/">Official releases are available from the Solr website</a>.
- </p>
-
<!--comment out this block if you want to hide search-->
<!--start search-->
@@ -1660,7 +1655,7 @@
<section class="content">
<section id="preamble" aria-label="Preamble"><p>The <code><initParams></code> section of <code>solrconfig.xml</code> allows you to define request handler parameters outside of the handler configuration.</p>
<p>There are a couple of use cases where this might be desired:</p>
-<div class="ulist"><ul><li>Some handlers are implicitly defined in code - see <a href="implicit-requesthandlers.html#implicit-requesthandlers">Implicit RequestHandlers</a> - and there should be a way to add/append/override some of the implicitly defined properties.</li><li>There are a few properties that are used across handlers. This helps you keep only a single definition of those properties and apply them over multiple handlers.</li></ul></div>
+<div class="ulist"><ul><li><p>Some handlers are implicitly defined in code - see <a href="implicit-requesthandlers.html#implicit-requesthandlers">Implicit RequestHandlers</a> - and there should be a way to add/append/override some of the implicitly defined properties.</p></li><li><p>There are a few properties that are used across handlers. This helps you keep only a single definition of those properties and apply them over multiple handlers.</p></li></ul></div>
<p>For example, if you want several of your search handlers to return the same list of fields, you can create an <code><initParams></code> section without having to define the same set of parameters in each request handler definition. If you have a single request handler that should return different fields, you can define the overriding parameters in individual <code><requestHandler></code> sections as usual.</p>
<p>The properties and configuration of an <code><initParams></code> section mirror the properties and configuration of a request handler. It can include sections for defaults, appends, and invariants, the same as any request handler.</p>
<p>For example, here is one of the <code><initParams></code> sections defined by default in the <code>_default</code> example:</p>
@@ -1687,7 +1682,7 @@
<span style="color: #000080"></lst></span>
<span style="color: #000080"></initParams></span></code></pre></code></pre></div>
<p>We’ve defined three paths with this section:</p>
-<div class="ulist"><ul><li><code>/myhandler</code> declared as a direct path.</li><li><code>/root/*</code> with a single asterisk to indicate the parameters should apply to paths that are one level deep.</li><li><code>/root1/**</code> with double asterisks to indicate the parameters should apply to all nested paths, no matter how deep.</li></ul></div>
+<div class="ulist"><ul><li><p><code>/myhandler</code> declared as a direct path.</p></li><li><p><code>/root/*</code> with a single asterisk to indicate the parameters should apply to paths that are one level deep.</p></li><li><p><code>/root1/**</code> with double asterisks to indicate the parameters should apply to all nested paths, no matter how deep.</p></li></ul></div>
<p>When we define the request handlers, the wildcards will work in the following ways:</p>
<div class="listingblock"><pre class="rouge highlight"><code class="language-xml" data-lang="xml"><pre class="highlight"><code><span style="color: #000080"><requestHandler</span> <span style="color: #008080">name=</span><span style="color: #d14">"/myhandler"</span> <span style="color: #008080">class=</span><span style="color: #d14">"SearchHandler"</span><span style="color: #000080">/></span></code></pre></code></pre></div>
<p>The <code>/myhandler</code> class was named as a path in the <code><initParams></code> so this will use those parameters.</p>
@@ -1727,7 +1722,7 @@
<div class="row">
<div class="col-lg-12 footer">
©2020 Apache Software Foundation. All rights reserved. <br />
- Site Version: 8.6-DRAFT <br />Site last generated: 2020-07-08 <br />
+ Site Version: 8.6 <br />Site last generated: 2020-07-15 <br />
<p><img src="images/solr-sunOnly-small.png" alt="Apache Solr"/></p>
</div>
</div>