Apache Solr open-source search software
SOLR-16198: Introduce tabbed blocks again (#2550)
Christos Malliaridisfedfbd15284e
diff --git a/dev-docs/ref-guide/asciidoc-syntax.adoc b/dev-docs/ref-guide/asciidoc-syntax.adocindex 866ef854757..5f32b895409 100644--- a/dev-docs/ref-guide/asciidoc-syntax.adoc+++ b/dev-docs/ref-guide/asciidoc-syntax.adoc@@ -503,90 +503,88 @@ This means that if we want an entire section of content to be given a specific rTIP: For more on Roles in Asciidoctor, see https://docs.asciidoctor.org/asciidoc/latest/attributes/roles/[Role Attribute] in the Asciidoctor User Guide.-=== Creating Tabbed Sections-Hopefully a little bit of background on roles is helpful to understanding the rest of what we'll do to create a tabbed section in a page.--See the Bootstrap docs on https://getbootstrap.com/docs/4.1/components/navs/#tabs[nav tabs] for details on how to use tabs and pills with Bootstrap.-As a quick overview, tabs in Bootstrap are defined like this:--[source,html]------<ul class="nav nav-pills"> <--1-->- <li class="active"><a data-toggle="pill" href="#sec1">Section 1</a></li>- <li><a data-toggle="pill" href="#sect2">Section 2</a></li>-</ul>--<div class="tab-content"> <--2-->- <div id="sect1" class="tab-pane active"> <--3-->- <h3>Section 1</h3>- <p>Some content.</p>- </div>- <div id="sect2" class="tab-pane">- <h3>Section 2</h3>- <p>Some other content.</p>- </div>-</div>------<1> This section creates an unordered list with a line item for each tab.-The `data-toggle` and `class` parameters are what tell Bootstrap how to render the content.-<2> Note the class defined here: `<div class="tab-content">`.-This defines that what follows is the content that will make up the panes of our tabs.-We will need to define these in our document.-<3> In our document, we need to delineate the separate sections of content that will make up each pane.--We have created some custom JavaScript that will do part of the above for us if we assign the proper roles to the blocks of content that we want to appear in the tab panes.-To do this, we can use Asciidoctor's block delimiters to define the tabbed content, and the content between the tab.--. Define an "open block" (an unformatted content block), and give it the role `.dynamic-tabs`.-An open block is defined by two hyphens on a line before the content that goes in the block, and two hyphens on a line after the content to end the block.-We give a block a role by adding a period before the role name, like this:+== Tabbed Sections+Tabbed sections are supported via https://github.com/asciidoctor/asciidoctor-tabs[`@asciidoctor/tabs`].++There are different ways to display tabbed sections via the asciidoctor tabs extension, but most of the time only the format of an example is needed.+This format wraps each tab content into an example block.++=== Referencing++By providing an ID to the `[tabs]` block like below, you can control the ID used for referencing the tabbed section.+An ID is also generated for each tab by aggregating the normalized tab label to the end of the `[tabs]` ID.+This allows a direct referencing of a specific tab, even if it is not currently selected.++=== Tab Synchronization++The IDs are also used for synchronizing the tab selection across the entire page.+This synchronization requires the tab labels to be named the same, so that the generated ID is correctly recognized.+To enable this feature, add `:tabs-sync-option:` below the page title.++[source,asciidoc]+----+= Page Title+:tab-sync-option:+...+----++It is also possible to group tabbed sections to sync only a set of tabs, or disable the syncing entirely.+See the https://github.com/asciidoctor/asciidoctor-tabs?tab=readme-ov-file#syntax[@asciidoctor/tabs syntax] fore more information.++=== Tabs Example++. Define a tabs block and give it an optional ID.+-[source,text]+[source,asciidoc]-----[.dynamic-tabs]----The stuff we'll put in the tabs will go here.---+[tabs#tab-section-id]-----. Next we need to define the content for the tabs between the open block delimiters.-.. We enclose each tab pane in another type of block, and "example" block.-This allows us to include any kind of content in the block and be sure all of the various types of elements (heading, text, examples, etc.) are included in the pane.-.. We give the example block another role, `tab-pane`, and we must make sure that each pane has a unique ID.-We assign IDs with a hash mark (\#) followed by the ID value (`#sect1`).-.. We also need to define a label for each tab.-We do this by adding another role, `tab-label` to the content we want to appear as the name of the tab.-.. In the end one pane will look like this:+. Next, we add an example block to wrap the tab's content with an outline. This is used for improved readability.+-[source,text]+[source,asciidoc]-----[example.tab-pane#sect1] <--1-->-==== <--2-->-[.tab-label]*Section 1* <--3-->-My content...-====+[tabs#tab-section-id]+======++======-----<1> When we define the example block with `[example]`, it's followed by `.tab-pane#sect1` as the class (each class separated by a period `.`) and the ID defined in the tab definition earlier.-Those will become the classes (`class="tab-pane active"`) and ID (`id="sect1"`) in the resulting HTML.-<2> Example blocks are delimited by 4 equal signs (`====`) before and after the enclosed content.-<3> The words "Section 1" will appear in the HTML page as the label for this tab.-.. Create `[example.tab-pane#id]` sections for each tab, until you finally end up with something that looks like this:+. Inside the example block, we can add our tabs. Each tab label is suffixed with `::` and the tab's content is wrapped inside a listing block.+-[source,text]+[source,asciidoc]-----[.dynamic-tabs]----[example.tab-pane#sect1]+Tab 1::++====-[.tab-label]*Section 1*-My content...+The first tab's content.====-[example.tab-pane#sect2]+Tab 2::++====-[.tab-label]*Section 2*-My content...+The second tab's content.====-------++The final result will look something like this:++[source,asciidoc]+----+[tabs#tab-section-id]+======+Tab 1::+++====+The first tab's content.+====++Tab 2::+++====+The second tab's content.+====+======+----++The tab section can be referenced via `#tab-section-id`, and each tab can be referenced via `#tab-section-id-tab-1` and `#tab-section-id-tab-2` accordingly.diff --git a/solr/CHANGES.txt b/solr/CHANGES.txtindex 8216966d3df..c7ec6e000c8 100644--- a/solr/CHANGES.txt+++ b/solr/CHANGES.txt@@ -148,6 +148,8 @@ Improvements* SOLR-17346: Synchronise stopwords from snowball with those in Lucene (Alastair Porter via Houston Putman)+* SOLR-16198: Introduce tabbed sections again in the Ref Guide. (Christos Malliaridis via Eric Pugh)+Optimizations---------------------* SOLR-17257: Both Minimize Cores and the Affinity replica placement strategies would over-gatherdiff --git a/solr/solr-ref-guide/build.gradle b/solr/solr-ref-guide/build.gradleindex fa73022ba5c..1e455f29849 100644--- a/solr/solr-ref-guide/build.gradle+++ b/solr/solr-ref-guide/build.gradle@@ -62,6 +62,7 @@ ext {antoraVersion = "3.1.4"antoraLunrExtensionVersion = "1.0.0-alpha.8"asciidoctorMathjaxVersion = "0.0.9"+ asciidoctorTabsVersion = "1.0.0-beta.6"linkCheckerVersion = "1.4.2"gulpCliVersion = "2.3.0"// Most recent commit as of 2022-06-24, this repo does not have tags@@ -246,6 +247,14 @@ task downloadAsciidoctorMathjaxExtension(type: NpmTask) {outputs.dir("${project.ext.nodeProjectDir}/node_modules/@djencks/asciidoctor-mathjax")}+task downloadAsciidoctorTabsExtension(type: NpmTask) {+ group = 'Build Dependency Download'+ args = ["install", "-D", "@asciidoctor/tabs@${project.ext.asciidoctorTabsVersion}"]++ inputs.property("asciidoctor-tabs version", project.ext.asciidoctorTabsVersion)+ outputs.dir("${project.ext.nodeProjectDir}/node_modules/@asciidoctor/tabs")+}+task downloadAntora {group = 'Build Dependency Download'description "Download all Antora build dependencies for site generation."@@ -254,6 +263,7 @@ task downloadAntora {dependsOn tasks.downloadAntoraSiteGeneratordependsOn tasks.downloadAntoraLunrExtensiondependsOn tasks.downloadAsciidoctorMathjaxExtension+ dependsOn tasks.downloadAsciidoctorTabsExtension}task downloadLinkValidator(type: NpmTask) {diff --git a/solr/solr-ref-guide/modules/configuration-guide/pages/collections-api.adoc b/solr/solr-ref-guide/modules/configuration-guide/pages/collections-api.adocindex 452c384bcc0..0ed88262b49 100644--- a/solr/solr-ref-guide/modules/configuration-guide/pages/collections-api.adoc+++ b/solr/solr-ref-guide/modules/configuration-guide/pages/collections-api.adoc@@ -1,5 +1,6 @@= Collections API:page-show-toc: false+:tabs-sync-option:// Licensed to the Apache Software Foundation (ASF) under one// or more contributor license agreements. See the NOTICE file// distributed with this work for additional information@@ -46,11 +47,11 @@ However, there is a limit of 10,000 on the number of async call responses stored*Input*-[.dynamic-tabs]----[example.tab-pane#v1asyncexample]+[tabs#asyncexample]+======+V1 API::++====-[.tab-label]*V1 API*[source,bash]----@@ -59,10 +60,9 @@ http://localhost:8983/solr/admin/collections?action=SPLITSHARD&collection=collec----====-[example.tab-pane#v2asyncexample]+V2 API::++====-[.tab-label]*V2 API*-[source,bash]----curl -X POST http://localhost:8983/api/collections/collection1/shards -H 'Content-Type: application/json' -d '@@ -75,7 +75,7 @@ curl -X POST http://localhost:8983/api/collections/collection1/shards -H 'Conten'----====---+======[source,text]@@ -101,29 +101,26 @@ curl -X POST http://localhost:8983/api/collections/collection1/shards -H 'ContenRequest the status and response of an already submitted <<Asynchronous Calls,Asynchronous Collection API>> (below) call.This call is also used to clear up the stored statuses.-[.dynamic-tabs]----[example.tab-pane#v1asyncrequeststatus]+[tabs#asyncrequeststatus]+======+V1 API::++====-[.tab-label]*V1 API*-[source,bash]----http://localhost:8983/solr/admin/collections?action=REQUESTSTATUS&requestid=1000----====--[example.tab-pane#v2asyncrequeststatus]+V2 API::++====-[.tab-label]*V2 API*-[source,bash]----curl -X GET http://localhost:8983/api/cluster/command-status/1000----====---+========= REQUESTSTATUS Parameters@@ -190,12 +187,11 @@ http://localhost:8983/solr/admin/collections?action=REQUESTSTATUS&requestid=1004Deletes the stored response of an already failed or completed <<Asynchronous Calls,Asynchronous Collection API>> call.-[.dynamic-tabs]----[example.tab-pane#v1asyncdeletestatus]+[tabs#asyncdeletestatus]+======+V1 API::++====-[.tab-label]*V1 API*-[source,bash]----http://localhost:8983/solr/admin/collections?action=DELETESTATUS&requestid=1000@@ -203,10 +199,9 @@ http://localhost:8983/solr/admin/collections?action=DELETESTATUS&requestid=1000----====-[example.tab-pane#v2asyncdeletestatus]+V2 API::++====-[.tab-label]*V2 API*-Delete a single request response:[source,bash]----@@ -219,7 +214,7 @@ Flush out all stored completed and failed async request responses:curl -X DELETE http://localhost:8983/api/cluster/command-status?flush=true----====---+========= DELETESTATUS Parametersdiff --git a/solr/solr-ref-guide/modules/configuration-guide/pages/config-api.adoc b/solr/solr-ref-guide/modules/configuration-guide/pages/config-api.adocindex cf12269d9be..05b2c490374 100644--- a/solr/solr-ref-guide/modules/configuration-guide/pages/config-api.adoc+++ b/solr/solr-ref-guide/modules/configuration-guide/pages/config-api.adoc@@ -1,4 +1,5 @@= Config API+:tabs-sync-option:// Licensed to the Apache Software Foundation (ASF) under one// or more contributor license agreements. See the NOTICE file// distributed with this work for additional information@@ -39,28 +40,26 @@ See xref:request-parameters-api.adoc[] for more information about this endpoint.All configuration items can be retrieved by sending a GET request to the `/config` endpoint:-[.dynamic-tabs]----[example.tab-pane#v1getconfig]+[tabs#getconfig]+======+V1 API::++====-[.tab-label]*V1 API*-[source,bash]----http://localhost:8983/solr/techproducts/config----====-[example.tab-pane#v2getconfig]+V2 API::++====-[.tab-label]*V2 API*-[source,bash]----http://localhost:8983/api/collections/techproducts/config----====---+======The response will be the Solr configuration resulting from merging settings in `configoverlay.json` with those in `solrconfig.xml`.@@ -69,28 +68,25 @@ It's possible to restrict the returned configuration to a top-level section, sucTo do this, append the name of the section to the `config` endpoint.For example, to retrieve configuration for all request handlers:-[.dynamic-tabs]----[example.tab-pane#v1gethandler]+[tabs#gethandler]+======+V1 API::++====-[.tab-label]*V1 API*-[source,bash]----http://localhost:8983/solr/techproducts/config/requestHandler----====--[example.tab-pane#v2gethandler]+V2 API::++====-[.tab-label]*V2 API*-[source,bash]----http://localhost:8983/api/collections/techproducts/config/requestHandler----====---+======The output will be details of each request handler defined in `solrconfig.xml`, xref:implicit-requesthandlers.adoc[defined implicitly] by Solr, and defined with this Config API stored in `configoverlay.json`.To see the configuration for implicit request handlers, add `expandParams=true` to the request.@@ -102,28 +98,25 @@ To further restrict the request to a single component within a top-level sectionFor example, to return configuration for the `/select` request handler:-[.dynamic-tabs]----[example.tab-pane#v1getcomponent]+[tabs#getcomponent]+======+V1 API::++====-[.tab-label]*V1 API*-[source,bash]----http://localhost:8983/solr/techproducts/config/requestHandler?componentName=/select----====--[example.tab-pane#v2getcomponent]+V2 API::++====-[.tab-label]*V2 API*-[source,bash]----http://localhost:8983/api/collections/techproducts/config/requestHandler?componentName=/select----====---+======The output of this command will look similar to:@@ -242,53 +235,48 @@ Constructing a command to modify or add one of these properties follows this patA request to increase the `updateHandler.autoCommit.maxTime` would look like:-[.dynamic-tabs]----[example.tab-pane#v1-setprop]+[tabs#setprop]+======+V1 API::++====-[.tab-label]*V1 API*-[source,bash]----curl -X POST -H 'Content-type: application/json' -d '{"set-property":{"updateHandler.autoCommit.maxTime":15000}}' http://localhost:8983/solr/techproducts/config----====--[example.tab-pane#v2-setprop]+V2 API::++====-[.tab-label]*V2 API*-[source,bash]----curl -X POST -H 'Content-type: application/json' -d '{"set-property":{"updateHandler.autoCommit.maxTime":15000}}' http://localhost:8983/api/collections/techproducts/config----====---+======You can use the `config/overlay` endpoint to verify the property has been added to `configoverlay.json`:-[.dynamic-tabs]----[example.tab-pane#v1overlay]+[tabs#overlay]+======+V1 API::++====-[.tab-label]*V1 API*-[source,bash]----curl http://localhost:8983/solr/techproducts/config/overlay?omitHeader=true----====-[example.tab-pane#v2overlay]+V2 API::++====-[.tab-label]*V2 API*-[source,bash]----curl http://localhost:8983/api/collections/techproducts/config/overlay?omitHeader=true----====---+======Output:@@ -306,28 +294,26 @@ Output:To unset the property:-[.dynamic-tabs]----[example.tab-pane#v1unsetprop]+[tabs#unsetprop]+======+V1 API::++====-[.tab-label]*V1 API*-[source,bash]----curl -X POST -H 'Content-type: application/json' -d '{"unset-property": "updateHandler.autoCommit.maxTime"}' http://localhost:8983/solr/techproducts/config----====-[example.tab-pane#v2unsetprop]+V2 API::++====-[.tab-label]*V2 API*-[source,bash]----curl -X POST -H 'Content-type: application/json' -d '{"unset-property": "updateHandler.autoCommit.maxTime"}' http://localhost:8983/api/collections/techproducts/config----====---+========= Commands for Handlers and Components@@ -405,12 +391,11 @@ curl -X POST -H 'Content-type:application/json' -d '{}' http://localhost:8983/solr/techproducts/config-----[.dynamic-tabs]----[example.tab-pane#v1addhandler]+[tabs#addhandler]+======+V1 API::++====-[.tab-label]*V1 API*-[source,bash]----curl -X POST -H 'Content-type:application/json' -d '{@@ -424,10 +409,9 @@ curl -X POST -H 'Content-type:application/json' -d '{----====-[example.tab-pane#v2addhandler]+V2 API::++====-[.tab-label]*V2 API*-[source,bash]----curl -X POST -H 'Content-type:application/json' -d '{@@ -440,7 +424,7 @@ curl -X POST -H 'Content-type:application/json' -d '{}' http://localhost:8983/api/collections/techproducts/config----====---+======Make a call to the new request handler to check if it is registered:@@ -467,12 +451,11 @@ And you should see the following as output:To update a request handler, you should use the `update-requesthandler` command:-[.dynamic-tabs]----[example.tab-pane#v1updatehandler]+[tabs#updatehandler]+======+V1 API::++====-[.tab-label]*V1 API*-[source,bash]----curl -X POST -H 'Content-type:application/json' -d '{@@ -486,10 +469,9 @@ curl -X POST -H 'Content-type:application/json' -d '{----====-[example.tab-pane#v2updatehandler]+V2 API::++====-[.tab-label]*V2 API*-[source,bash]----curl -X POST -H 'Content-type:application/json' -d '{@@ -502,16 +484,15 @@ curl -X POST -H 'Content-type:application/json' -d '{}' http://localhost:8983/api/collections/techproducts/config----====---+======As a second example, we'll create another request handler, this time adding the 'terms' component as part of the definition:-[.dynamic-tabs]----[example.tab-pane#v1add-handler]+[tabs#add-handler]+======+V1 API::++====-[.tab-label]*V1 API*-[source,bash]----curl -X POST -H 'Content-type:application/json' -d '{@@ -525,10 +506,9 @@ curl -X POST -H 'Content-type:application/json' -d '{----====-[example.tab-pane#v2add-handler]+V2 API::++====-[.tab-label]*V2 API*-[source,bash]----curl -X POST -H 'Content-type:application/json' -d '{@@ -541,16 +521,15 @@ curl -X POST -H 'Content-type:application/json' -d '{}' http://localhost:8983/api/collections/techproducts/config----====---+======Finally we will go ahead and remove the request handler via the `delete-requesthandler` command:-[.dynamic-tabs]----[example.tab-pane#v1delete-handler]+[tabs#delete-handler]+======+V1 API::++====-[.tab-label]*V1 API*-[source,bash]----curl -X POST -H 'Content-type:application/json' -d '{@@ -559,10 +538,9 @@ curl -X POST -H 'Content-type:application/json' -d '{----====-[example.tab-pane#v2delete-handler]+V2 API::++====-[.tab-label]*V2 API*-[source,bash]----curl -X POST -H 'Content-type:application/json' -d '{@@ -570,7 +548,7 @@ curl -X POST -H 'Content-type:application/json' -d '{}' http://localhost:8983/api/collections/techproducts/config----====---+========= Commands for User-Defined Properties@@ -593,53 +571,49 @@ See also the section <<Creating and Updating User-Defined Properties>> below forThis command sets a user property.-[.dynamic-tabs]----[example.tab-pane#v1userprop]+[tabs#userprop]+======+V1 API::++====-[.tab-label]*V1 API*-[source,bash]----curl -X POST -H 'Content-type:application/json' -d '{"set-user-property": {"variable_name": "some_value"}}' http://localhost:8983/solr/techproducts/config----====-[example.tab-pane#v2userprop]+V2 API::++====-[.tab-label]*V2 API*-[source,bash]----curl -X POST -H 'Content-type:application/json' -d '{"set-user-property": {"variable_name": "some_value"}}' http://localhost:8983/api/collections/techproducts/config----====---+======Again, we can use the `/config/overlay` endpoint to verify the changes have been made:-[.dynamic-tabs]----[example.tab-pane#v1useroverlay]+[tabs#useroverlay]+======+V1 API::++====-[.tab-label]*V1 API*-[source,bash]----curl http://localhost:8983/solr/techproducts/config/overlay?omitHeader=true----====-[example.tab-pane#v2useroverlay]+V2 API::++====-[.tab-label]*V2 API*-[source,bash]----curl http://localhost:8983/api/collections/techproducts/config/overlay?omitHeader=true----====---+======And we would expect to see output like this:@@ -654,28 +628,26 @@ And we would expect to see output like this:To unset the variable, issue a command like this:-[.dynamic-tabs]----[example.tab-pane#v1unsetuser]+[tabs#unsetuser]+======+V1 API::++====-[.tab-label]*V1 API*-[source,bash]----curl -X POST -H 'Content-type:application/json' -d '{"unset-user-property": "variable_name"}' http://localhost:8983/solr/techproducts/config----====-[example.tab-pane#v2unsetuser]+V2 API::++====-[.tab-label]*V2 API*-[source,bash]----curl -X POST -H 'Content-type:application/json' -d '{"unset-user-property": "variable_name"}' http://localhost:8983/api/collections/techproducts/config----====---+========= updateRequestProcessorChain Elements@@ -684,12 +656,11 @@ However, it is possible to create `updateProcessor` entries and use them by nameFor example:-[.dynamic-tabs]----[example.tab-pane#v1addupdateproc]+[tabs#addupdateproc]+======+V1 API::++====-[.tab-label]*V1 API*-[source,bash]----curl -X POST -H 'Content-type:application/json' -d '{"add-updateprocessor":@@ -700,10 +671,9 @@ curl -X POST -H 'Content-type:application/json' -d '{"add-updateprocessor":----====-[example.tab-pane#v2addupdateproc]+V2 API::++====-[.tab-label]*V2 API*-[source,bash]----curl -X POST -H 'Content-type:application/json' -d '{"add-updateprocessor":@@ -713,7 +683,7 @@ curl -X POST -H 'Content-type:application/json' -d '{"add-updateprocessor":}' http://localhost:8983/api/collections/techproducts/config----====---+======You can use this directly in your request by adding a parameter in the `updateRequestProcessorChain` for the specific update processor called `processor=firstFld`.@@ -809,6 +779,7 @@ A simple highlighter looks like this in `solrconfig.xml` (example has been trunc<encoder name="html" class="solr.highlight.HtmlEncoder" />...</highlighting>+</searchComponent>----The same highlighter with the Config API:@@ -893,28 +864,26 @@ If `params.json` is modified, the params object is just updated without a core rIf an empty command is sent to the `/config` endpoint, the watch is triggered on all cores using this configset.For example:-[.dynamic-tabs]----[example.tab-pane#v1empty]+[tabs#empty]+======+V1 API::++====-[.tab-label]*V1 API*-[source,bash]----curl -X POST -H 'Content-type:application/json' -d '{}' http://localhost:8983/solr/techproducts/config----====-[example.tab-pane#v2empty]+V2 API::++====-[.tab-label]*V2 API*-[source,bash]----curl -X POST -H 'Content-type:application/json' -d '{}' http://localhost:8983/api/collections/techproducts/config----====---+======Directly editing any files without 'touching' the directory *will not* make it visible to all nodes.diff --git a/solr/solr-ref-guide/modules/configuration-guide/pages/config-sets.adoc b/solr/solr-ref-guide/modules/configuration-guide/pages/config-sets.adocindex a04d6e41d18..445f9cdb97d 100644--- a/solr/solr-ref-guide/modules/configuration-guide/pages/config-sets.adoc+++ b/solr/solr-ref-guide/modules/configuration-guide/pages/config-sets.adoc@@ -1,4 +1,5 @@= Configsets+:tabs-sync-option:// Licensed to the Apache Software Foundation (ASF) under one// or more contributor license agreements. See the NOTICE file// distributed with this work for additional information@@ -55,23 +56,20 @@ This path can be configured with the `configSetBaseDir` parameter in `solr.xml`To create a new core using a configset, pass `configSet` as one of the core properties.For example, if you do this via the CoreAdmin API:-[.dynamic-tabs]-----[example.tab-pane#v1use-configset]+[tabs#use-configset]+======+V1 API::++====-[.tab-label]*V1 API*-[source,bash]----curl http://localhost:8983/admin/cores?action=CREATE&name=mycore&instanceDir=path/to/instance&configSet=configset2----====-[example.tab-pane#v2use-configset]+V2 API::++====-[.tab-label]*V2 API*-[source,bash]----curl -v -X POST -H 'Content-type: application/json' -d '{@@ -82,7 +80,7 @@ curl -v -X POST -H 'Content-type: application/json' -d '{http://localhost:8983/api/cores----====---+======== Configsets in SolrCloud Clustersdiff --git a/solr/solr-ref-guide/modules/configuration-guide/pages/configsets-api.adoc b/solr/solr-ref-guide/modules/configuration-guide/pages/configsets-api.adocindex 46087834555..45987271de6 100644--- a/solr/solr-ref-guide/modules/configuration-guide/pages/configsets-api.adoc+++ b/solr/solr-ref-guide/modules/configuration-guide/pages/configsets-api.adoc@@ -1,4 +1,5 @@= Configsets API+:tabs-sync-option::toclevels: 1// Licensed to the Apache Software Foundation (ASF) under one// or more contributor license agreements. See the NOTICE file@@ -42,12 +43,11 @@ Examples of both types are provided below.The `list` command fetches the names of the configsets that are available for use during collection creation.-[.dynamic-tabs]----[example.tab-pane#v1listconfigset]+[tabs#listconfigset]+======+V1 API::++====-[.tab-label]*V1 API*-With the v1 API, the `list` command must be capitalized as `LIST`:[source,bash]@@ -57,10 +57,9 @@ http://localhost:8983/solr/admin/configs?action=LIST&omitHeader=true----====-[example.tab-pane#v2listconfigset]+V2 API::++====-[.tab-label]*V2 API*-With the v2 API, the `list` command is implied when there is no data sent with the request.[source,bash]@@ -68,7 +67,7 @@ With the v2 API, the `list` command is implied when there is no data sent with thttp://localhost:8983/api/cluster/configs?omitHeader=true----====---+======The output will look like:@@ -152,12 +151,11 @@ The zip file must be created from within the `conf` directory (i.e., `solrconfigHere is an example on how to create the zip file named "myconfig.zip" and upload it as a configset named "myConfigSet":-[.dynamic-tabs]----[example.tab-pane#v1uploadconfigset]+[tabs#uploadconfigset]+======+V1 API::++====-[.tab-label]*V1 API*-With the v1 API, the `upload` command must be capitalized as `UPLOAD`:[source,bash]@@ -175,10 +173,9 @@ $ (cd server/solr/configsets/sample_techproducts_configs/conf && zip -r - *) | c----====-[example.tab-pane#v2uploadconfigset]+V2 API::++====-[.tab-label]*V2 API*-With the v2 API, the name of the configset to upload is provided as a path parameter:[source,bash]@@ -192,16 +189,15 @@ $ curl -X PUT --header "Content-Type:application/octet-stream" --data-binary @myWith this API, the default behavior is to overwrite the configset if it already exists.This behavior can be disabled with the parameter `overwrite=false`, in which case the request will fail if the configset already exists.====---+======Here is an example on how to upload a single file to a configset named "myConfigSet":-[.dynamic-tabs]----[example.tab-pane#v1uploadsinglefile]+[tabs#uploadsinglefile]+======+V1 API::++====-[.tab-label]*V1 API*-With the v1 API, the `upload` command must be capitalized as `UPLOAD`.The filename to upload is provided via the `filePath` parameter:@@ -213,10 +209,9 @@ curl -X POST --header "Content-Type:application/octet-stream"----====-[example.tab-pane#v2uploadsinglefile]+V2 API::++====-[.tab-label]*V2 API*-With the v2 API, the name of the configset and file are both provided in the URL.They can be substituted in `/cluster/configs/__config_name__/__file_name__`.The filename may be nested and include `/` characters.@@ -231,7 +226,7 @@ curl -X PUT --header "Content-Type:application/octet-stream"With this API, the default behavior is to overwrite the file if it already exists within the configset.This behavior can be disabled with the parameter `overwrite=false`, in which case the request will fail if the file already exists within the configset.====---+======[[configsets-create]]== Create a Configset@@ -271,12 +266,11 @@ A configset property from the base configset to override in the copied configsetFor example, to create a configset named "myConfigset" based on a previously defined "predefinedTemplate" configset, overriding the immutable property to false.-[.dynamic-tabs]----[example.tab-pane#v1createconfigset]+[tabs#createconfigset]+======+V1 API::++====-[.tab-label]*V1 API*-With the v1 API, the `create` command must be capitalized as `CREATE`:[source,bash]@@ -285,10 +279,9 @@ http://localhost:8983/solr/admin/configs?action=CREATE&name=myConfigSet&baseConf----====-[example.tab-pane#v2createconfigset]+V2 API::++====-[.tab-label]*V2 API*-With the v2 API, the `create` command is provided as part of the JSON data that contains the required parameters:[source,bash]@@ -315,7 +308,7 @@ curl -X POST -H 'Content-type: application/json' -d '{http://localhost:8983/api/cluster/configs?omitHeader=true----====---+======*Output*@@ -346,12 +339,11 @@ The configset to be deleted.To delete a configset named "myConfigSet":-[.dynamic-tabs]----[example.tab-pane#v1deleteconfigset]+[tabs#deleteconfigset]+======+V1 API::++====-[.tab-label]*V1 API*-With the v1 API, the `delete` command must be capitalized as `DELETE`.The name of the configset to delete is provided with the `name` parameter:@@ -361,10 +353,9 @@ http://localhost:8983/solr/admin/configs?action=DELETE&name=myConfigSet&omitHead----====-[example.tab-pane#v2deleteconfigset]+V2 API::++====-[.tab-label]*V2 API*-With the v2 API, the `delete` command is provided as the request method, as in `-X DELETE`.The name of the configset to delete is provided as a path parameter:@@ -373,7 +364,7 @@ The name of the configset to delete is provided as a path parameter:curl -X DELETE http://localhost:8983/api/cluster/configs/myConfigSet?omitHeader=true----====---+======*Output*diff --git a/solr/solr-ref-guide/modules/configuration-guide/pages/coreadmin-api.adoc b/solr/solr-ref-guide/modules/configuration-guide/pages/coreadmin-api.adocindex 5e4cec74221..68873c6ca7d 100644--- a/solr/solr-ref-guide/modules/configuration-guide/pages/coreadmin-api.adoc+++ b/solr/solr-ref-guide/modules/configuration-guide/pages/coreadmin-api.adoc@@ -1,4 +1,5 @@= CoreAdmin API+:tabs-sync-option::toclevels: 1// Licensed to the Apache Software Foundation (ASF) under one// or more contributor license agreements. See the NOTICE file@@ -43,12 +44,11 @@ We are passing in the explicit relative path for the `configSetBaseDir` to enablThe `STATUS` action returns the status of all running Solr cores, or status for only the named core.-[.dynamic-tabs]----[example.tab-pane#v1coreadmin-status]+[tabs#coreadmin-status-request]+======+V1 API::++====-[.tab-label]*V1 API*-[source,bash]----http://localhost:8983/solr/admin/cores?action=STATUS&core=techproducts@@ -56,10 +56,9 @@ http://localhost:8983/solr/admin/cores?action=STATUS&core=techproducts----====-[example.tab-pane#v2coreadmin-status]+V2 API::++====-[.tab-label]*V2 API*-[source,bash]----curl -X GET http://localhost:8983/api/cores/@@ -80,7 +79,7 @@ curl -X GET http://localhost:8983/api/cores?indexInfo=false----====---+========= STATUS Parameters@@ -113,12 +112,11 @@ If a Solr core with the given name already exists, it will continue to handle reWhen the new core is ready, it will take new requests and the old core will be unloaded.`admin/cores?action=CREATE&name=_core-name_&instanceDir=_path/to/dir_&config=solrconfig.xml&dataDir=data`-[.dynamic-tabs]----[example.tab-pane#v1coreadmin-create]+[tabs#coreadmin-create-request]+======+V1 API::++====-[.tab-label]*V1 API*-Assuming you are using an existing configSet to create your new core:[source,bash]----@@ -133,10 +131,9 @@ http://localhost:8983/solr/admin/cores?action=CREATE&name=_core-name_&instanceDi----====-[example.tab-pane#v2coreadmin-create]+V2 API::++====-[.tab-label]*V2 API*-[source,bash]----curl -X POST http://localhost:8983/api/cores -H 'Content-Type: application/json' -d '@@ -149,7 +146,7 @@ curl -X POST http://localhost:8983/api/cores -H 'Content-Type: application/json''----====---+======Note that this command is the only one of the Core Admin API commands that *does not* support the `core` parameter.Instead, the `name` parameter is required, as shown below.@@ -299,12 +296,11 @@ The RELOAD action loads a new core from the configuration of an existing, registWhile the new core is initializing, the existing one will continue to handle requests.When the new Solr core is ready, it takes over and the old core is unloaded.-[.dynamic-tabs]----[example.tab-pane#v1coreadmin-reload]+[tabs#coreadmin-reload-request]+======+V1 API::++====-[.tab-label]*V1 API*-[source,bash]----http://localhost:8983/solr/admin/cores?action=RELOAD&core=techproducts@@ -312,16 +308,16 @@ http://localhost:8983/solr/admin/cores?action=RELOAD&core=techproducts----====-[example.tab-pane#v2coreadmin-reload]+V2 API::++====-[.tab-label]*V2 API*[source,bash]----curl -X POST http://localhost:8983/api/cores/techproducts/reload----====---+======This is useful when you've made changes to a Solr core's configuration on disk, such as adding new field definitions.Calling the RELOAD action lets you apply the new configuration without having to restart Solr.@@ -349,20 +345,19 @@ This parameter is required in v1, and part of the url in the v2 API.The `RENAME` action changes the name of a Solr core.-[.dynamic-tabs]----[example.tab-pane#v1coreadmin-rename]+[tabs#coreadmin-rename-request]+======+V1 API::++====-[.tab-label]*V1 API*[source,bash]----curl -X GET "http://localhost:8983/solr/admin/cores?action=RENAME&core=currentCoreName&other=newCoreName"----====--[example.tab-pane#v2coreadmin-rename]+V2 API::++====-[.tab-label]*V2 API*[source,bash]----curl -X POST http://localhost:8983/api/cores/currentCoreName/rename -H 'Content-Type: application/json' -d '@@ -372,7 +367,7 @@ curl -X POST http://localhost:8983/api/cores/currentCoreName/rename -H 'Content-'----====---+========= RENAME Parameters@@ -414,22 +409,19 @@ This can be used to swap new content into production.The prior core remains available and can be swapped back, if necessary.Each core will be known by the name of the other, after the swap.-[.dynamic-tabs]----[example.tab-pane#v1coreadmin-swap]+[tabs#coreadmin-swap-request]+======+V1 API::++====-[.tab-label]*V1 API*-[source,bash]----`admin/cores?action=SWAP&core=_core-name_&other=_other-core-name_`----====--[example.tab-pane#v2coreadmin-swap]+V2 API::++====-[.tab-label]*V2 API*-[source,bash]----curl -X POST http://localhost:8983/api/cores/_core-name_/swap -H 'Content-Type: application/json' -d '@@ -439,7 +431,7 @@ curl -X POST http://localhost:8983/api/cores/_core-name_/swap -H 'Content-Type:'----====---+======[IMPORTANT]====@@ -484,23 +476,20 @@ The `UNLOAD` action removes a core from Solr.Active requests will continue to be processed, but no new requests will be sent to the named core.If a core is registered under more than one name, only the given name is removed.-[.dynamic-tabs]----[example.tab-pane#v1coreadmin-unload]+[tabs#coreadmin-unload-request]+======+V1 API::++====-[.tab-label]*V1 API*-[source,bash]----http://localhost:8983/solr/admin/cores?actionUNLOAD&core=techproducts----====--[example.tab-pane#v2coreadmin-unload]+V2 API::++====-[.tab-label]*V2 API*-[source,bash]----curl -X POST http://localhost:8983/api/cores/techproducts/unload -H 'Content-Type: application/json' -d '@@ -508,7 +497,7 @@ curl -X POST http://localhost:8983/api/cores/techproducts/unload -H 'Content-Typ'----====---+======The `UNLOAD` action requires a parameter (`core`) identifying the core to be removed.If the persistent attribute of `<solr>` is set to `true`, the `<core>` element with this `name` attribute will be removed from `solr.xml`.@@ -573,18 +562,21 @@ The `MERGEINDEXES` action merges one or more indexes to another index.The indexes must have completed commits, and should be locked against writes until the merge is complete or the resulting merged index may become corrupted.The target core index must already exist and have a compatible schema with the one or more indexes that will be merged to it.Another commit on the target core should also be performed after the merge is complete.----[example.tab-pane#v1coreadmin-mergeindexes-dir]++[tabs#coreadmin-mergeindexes-dir-request]+======+V1 API::++====-[.tab-label]*V1 API*[source,bash]----curl -X GET "http://localhost:8983/solr/admin/cores?action=MERGEINDEXES&core=targetCoreName&indexDir=path/to/core1/data/index&indexDir=path/to/core2/data/index"----====-[example.tab-pane#v2coreadmin-mergeindexes-dir]++V2 API::++====-[.tab-label]*V2 API*[source,bash]----curl -X POST http://localhost:8983/api/cores/targetCoreName/merge-indices -H 'Content-Type: application/json' -d '@@ -594,25 +586,28 @@ curl -X POST http://localhost:8983/api/cores/targetCoreName/merge-indices -H 'Co'----====---+======In this example, we use the `indexDir` parameter (`indexDirs` in the v2 API) to define the index locations of the source cores.The `core` parameter defines the target index.A benefit of this approach is that we can merge any Lucene-based index that may not be associated with a Solr core.Alternatively, we can instead use a `srcCore` parameter (`srcCores` in the v2 API), as in the example below:----[example.tab-pane#v1coreadmin-mergeindexes-core]++[tabs#coreadmin-mergeindexes-core-request]+======+V1 API::++====-[.tab-label]*V1 API*[source,bash]----curl -X GET "http://localhost:8983/solr/admin/cores?action=mergeindexes&core=targetCoreName&srcCore=core1&srcCore=core2"----====-[example.tab-pane#v2coreadmin-mergeindexes-core]++V2 API::++====-[.tab-label]*V2 API*[source,bash]----curl -X POST http://localhost:8983/api/cores/targetCoreName/merge-indices -H 'Content-Type: application/json' -d '@@ -622,7 +617,8 @@ curl -X POST http://localhost:8983/api/cores/targetCoreName/merge-indices -H 'Co'----====---+======+This approach allows us to define cores that may not have an index path that is on the same physical server as the target core.However, we can only use Solr cores as the source indexes.Another benefit of this approach is that we don't have as high a risk for corruption if writes occur in parallel with the source index.@@ -788,27 +784,28 @@ If the `split.key` parameter is specified then only documents having the same ro== REQUESTSTATUSRequest the status of an already submitted asynchronous CoreAdmin API call.----[example.tab-pane#v1coreadmin-requeststatus]-====-[.tab-label]*V1 API*+[tabs#coreadmin-requeststatus-request]+======+V1 API::+++====[source,bash]----http://localhost:8983/solr/admin/cores?action=REQUESTSTATUS&requestid=id----====-[example.tab-pane#v2coreadmin-requeststatus]-====-[.tab-label]*V2 API*+V2 API::+++====[source,bash]----curl -X GET http://localhost:8983/api/node/commands/id----====---+========= Core REQUESTSTATUS Parametersdiff --git a/solr/solr-ref-guide/modules/configuration-guide/pages/implicit-requesthandlers.adoc b/solr/solr-ref-guide/modules/configuration-guide/pages/implicit-requesthandlers.adocindex ad0286c0540..45e4468e8f7 100644--- a/solr/solr-ref-guide/modules/configuration-guide/pages/implicit-requesthandlers.adoc+++ b/solr/solr-ref-guide/modules/configuration-guide/pages/implicit-requesthandlers.adoc@@ -1,5 +1,6 @@= Implicit Request Handlers:page-children: system-info-handler+:tabs-sync-option:// Licensed to the Apache Software Foundation (ASF) under one// or more contributor license agreements. See the NOTICE file// distributed with this work for additional information@@ -326,28 +327,26 @@ To include the expanded paramset in the response, as well as the effective paramFor example, for the `/export` request handler, you can make a request like this:-[.dynamic-tabs]----[example.tab-pane#v1expandparams]+[tabs#expandparams]+======+V1 API::++====-[.tab-label]*V1 API*-[source,bash]----http://localhost:8983/solr/gettingstarted/config/requestHandler?componentName=/export&expandParams=true----====-[example.tab-pane#v2expandparams]+V2 API::++====-[.tab-label]*V2 API*-[source,bash]----http://localhost:8983/api/collections/gettingstarted/config/requestHandler?componentName=/export&expandParams=true----====---+======The response will look similar to:diff --git a/solr/solr-ref-guide/modules/configuration-guide/pages/property-substitution.adoc b/solr/solr-ref-guide/modules/configuration-guide/pages/property-substitution.adocindex 752ae1a7f76..3f756da1470 100644--- a/solr/solr-ref-guide/modules/configuration-guide/pages/property-substitution.adoc+++ b/solr/solr-ref-guide/modules/configuration-guide/pages/property-substitution.adoc@@ -1,4 +1,5 @@= Property Substitution in Configuration Files+:tabs-sync-option:// Licensed to the Apache Software Foundation (ASF) under one// or more contributor license agreements. See the NOTICE file// distributed with this work for additional information@@ -78,28 +79,26 @@ When you create a SolrCloud collection, you can pass through custom parameters bFor example, to add a property named "my.custom.prop":-[.dynamic-tabs]----[example.tab-pane#v1customprop]+[tabs#customprop]+======+V1 API::++====-[.tab-label]*V1 API*-[source,bash]----http://localhost:8983/solr/admin/collections?action=CREATE&name=gettingstarted&numShards=1&property.my.custom.prop=edismax----====-[example.tab-pane#v2]+V2 API::++====-[.tab-label]*V2 API*-[source,bash]----curl -X POST -H 'Content-type: application/json' -d '{"name": "gettingstarted", "numShards": 1, "properties": {"my.custom.prop": "edismax"}}' http://localhost:8983/api/collections----====---+======This will create a `core.properties` file that has at least the following properties (others omitted for brevity):diff --git a/solr/solr-ref-guide/modules/configuration-guide/pages/realtime-get.adoc b/solr/solr-ref-guide/modules/configuration-guide/pages/realtime-get.adocindex c6fc3c8b63d..d362aed79a2 100644--- a/solr/solr-ref-guide/modules/configuration-guide/pages/realtime-get.adoc+++ b/solr/solr-ref-guide/modules/configuration-guide/pages/realtime-get.adoc@@ -1,4 +1,5 @@= RealTime Get+:tabs-sync-option:// Licensed to the Apache Software Foundation (ASF) under one// or more contributor license agreements. See the NOTICE file// distributed with this work for additional information@@ -65,11 +66,11 @@ http://localhost:8983/solr/techproducts/query?q=id:mydocHowever if you use the Real Time Get handler exposed at `/get`, you can retrieve the document:-[.dynamic-tabs]----[.tab-pane#v1get]+[tabs#get]+======+V1 API::++====-[.tab-label]*V1 API*[source,bash]----http://localhost:8983/solr/techproducts/get?id=mydoc@@ -86,9 +87,9 @@ http://localhost:8983/solr/techproducts/get?id=mydoc----====-[.tab-pane#v2get]+V2 API::++====-[.tab-label]*V2 API*[source,bash]----http://localhost:8983/api/collections/techproducts/get?id=mydoc@@ -104,18 +105,18 @@ http://localhost:8983/api/collections/techproducts/get?id=mydoc}----====---+======You can also specify multiple documents at once via the `ids` parameter and a comma separated list of ids, or by using multiple `id` parameters.If you specify multiple ids, or use the `ids` parameter, the response will mimic a normal query response to make it easier for existing clients to parse.For example:-[.dynamic-tabs]----[.tab-pane#v1getids]+[tabs#getids]+======+V1 API::++====-[.tab-label]*V1 API*[source,bash]----http://localhost:8983/solr/techproducts/get?ids=mydoc,IW-02@@ -139,9 +140,9 @@ http://localhost:8983/solr/techproducts/get?id=mydoc&id=IW-02----====-[.tab-pane#v2getids]+V2 API::++====-[.tab-label]*V2 API*[source,bash]----http://localhost:8983/api/collections/techproducts/get?ids=mydoc,IW-02@@ -164,15 +165,15 @@ http://localhost:8983/api/collections/techproducts/get?id=mydoc&id=IW-02}----====---+======Real Time Get requests can also be combined with filter queries, specified with an xref:query-guide:common-query-parameters.adoc#fq-filter-query-parameter[`fq` parameter]:-[.dynamic-tabs]----[.tab-pane#v1getfq]+[tabs#getfq]+======+V1 API::++====-[.tab-label]*V1 API*[source,bash]----http://localhost:8983/solr/techproducts/get?id=mydoc&id=IW-02&fq=name:realtime-get@@ -191,9 +192,9 @@ http://localhost:8983/solr/techproducts/get?id=mydoc&id=IW-02&fq=name:realtime-g----====-[.tab-pane#v2getfq]+V2 API::++====-[.tab-label]*V2 API*[source,bash]----http://localhost:8983/api/collections/techproducts/get?id=mydoc&id=IW-02&fq=name:realtime-get@@ -211,7 +212,7 @@ http://localhost:8983/api/collections/techproducts/get?id=mydoc&id=IW-02&fq=name}----====---+======[WARNING]====diff --git a/solr/solr-ref-guide/modules/deployment-guide/pages/alias-management.adoc b/solr/solr-ref-guide/modules/deployment-guide/pages/alias-management.adocindex 2853a039e5a..1c58ab0c380 100644--- a/solr/solr-ref-guide/modules/deployment-guide/pages/alias-management.adoc+++ b/solr/solr-ref-guide/modules/deployment-guide/pages/alias-management.adoc@@ -1,4 +1,5 @@= Alias Management+:tabs-sync-option::toclevels: 1// Licensed to the Apache Software Foundation (ASF) under one// or more contributor license agreements. See the NOTICE file@@ -310,13 +311,11 @@ The initial collection for routed aliases should also be visible in various part=== Examples using CREATEALIASCreate an alias named "testalias" and link it to the collections named "foo" and "bar".-[.dynamic-tabs]-----[example.tab-pane#v1createAlias]+[tabs#createAlias-request]+======+V1 API::++====-[.tab-label]*V1 API*-*Input*[source,text]@@ -337,9 +336,9 @@ http://localhost:8983/solr/admin/collections?action=CREATEALIAS&name=testalias&c----====-[example.tab-pane#v2createAlias]+V2 API::++====-[.tab-label]*V2 API**Input*[source,bash]@@ -351,6 +350,7 @@ curl -X POST http://localhost:8983/api/aliases -H 'Content-Type: application/jso}'----+*Output*[source,json]@@ -363,17 +363,15 @@ curl -X POST http://localhost:8983/api/aliases -H 'Content-Type: application/jso}----====---+======A somewhat contrived example demonstrating creating a TRA with many additional collection creation options.-[.dynamic-tabs]-----[example.tab-pane#v1createTRA]+[tabs#createTRA-request]+======+V1 API::++====-[.tab-label]*V1 API*-*Input*[source,text]@@ -409,13 +407,11 @@ http://localhost:8983/solr/admin/collections?action=CREATEALIAS----====-[example.tab-pane#v2createTRA]+V2 API::++====-[.tab-label]*V2 API*-*Input*-[source,bash]----curl -X POST http://localhost:8983/api/aliases -H 'Content-Type: application/json' -d '@@ -460,19 +456,16 @@ curl -X POST http://localhost:8983/api/aliases -H 'Content-Type: application/jso}----====----+======Another example, this time of a Dimensional Routed Alias demonstrating how to specify parameters for theindividual dimensions-[.dynamic-tabs]-----[example.tab-pane#v1createDRA]+[tabs#createDRA-request]+======+V1 API::++====-[.tab-label]*V1 API*-*Input*[source,text]@@ -504,10 +497,9 @@ http://localhost:8983/solr/admin/collections?action=CREATEALIAS----====-[example.tab-pane#v2createDRA]+V2 API::++====-[.tab-label]*V2 API*-*Input*[source,bash]@@ -536,6 +528,7 @@ curl -X POST http://localhost:8983/api/aliases -H 'Content-Type: application/jso}'----+*Output*[source,json]@@ -548,45 +541,45 @@ curl -X POST http://localhost:8983/api/aliases -H 'Content-Type: application/jso}----====----+======[[listaliases]]== LISTALIASES: List of all aliases in the cluster-[.dynamic-tabs]----[example.tab-pane#v1listaliases]+[tabs#listaliases-request]+======+V1 API::++====-[.tab-label]*V1 API*-[source,bash]----curl -X GET 'http://localhost:8983/solr/admin/collections?action=LISTALIASES'----====-[example.tab-pane#v2listaliases]+V2 API::++====-[.tab-label]*V2 API*-[source,bash]----curl -X GET http://localhost:8983/api/aliases----====---+========= LISTALIASES Getting details for a single alias-[example.tab-pane#v2listsinglealias]-====-[.tab-label]*V2 API only*+[tabs#listsignlealias-request]+======+V2 API only::+++====[source,bash]----curl -X GET http://localhost:8983/api/aliases/testalias2----====+========= LISTALIASES Response@@ -659,22 +652,20 @@ curl -X GET http://localhost:8983/api/aliases/testalias2The `ALIASPROP` action modifies the properties (metadata) on an alias.If a key is set with a value that is empty it will be removed.-[.dynamic-tabs]----[example.tab-pane#v1aliasprop]+[tabs#aliasprop-request]+======+V1 API::++====-[.tab-label]*V1 API*-[source,bash]----curl -X POST 'http://localhost:8983/admin/collections?action=ALIASPROP&name=techproducts_alias&property.foo=bar'----====-[example.tab-pane#v2aliasprop]+V2 API::++====-[.tab-label]*V2 API*-[source,bash]----curl -X PUT http://localhost:8983/api/aliases/techproducts_alias/properties -H 'Content-Type: application/json' -d '@@ -685,10 +676,9 @@ curl -X PUT http://localhost:8983/api/aliases/techproducts_alias/properties -H '====-[example.tab-pane#v2aliasplevelprop]+V2 API Update via property level api::++====-[.tab-label]*V2 API* Update via property level api-[source,bash]----curl -X PUT http://localhost:8983/api/aliases/techproducts_alias/properties/foo -H 'Content-Type: application/json' -d '@@ -698,20 +688,15 @@ curl -X PUT http://localhost:8983/api/aliases/techproducts_alias/properties/foo----====--[example.tab-pane#v2deleteplevelprop]+V2 API Delete via property level api::++====-[.tab-label]*V2 API* Delete via property level api-[source,bash]----curl -X DELETE http://localhost:8983/api/aliases/techproducts_alias/properties/foo -H 'Content-Type: application/json'-----====-----+======WARNING: This command allows you to revise any property.No alias specific validation is performed.@@ -767,12 +752,11 @@ Retrieves the metadata properties associated with a specified alias.Solr's v2 API supports either listing out these properties in bulk or accessing them individually by name, as necessary.-[.dynamic-tabs]----[example.tab-pane#v2listallprops]+[tabs#listallprops-request]+======+V2 API Get all properties on an alias::++====-[.tab-label]*V2 API* Get all properties on an alias-[source,bash]----curl -X GET http://localhost:8983/api/aliases/techproducts_alias/properties@@ -794,10 +778,9 @@ curl -X GET http://localhost:8983/api/aliases/techproducts_alias/properties----====-[example.tab-pane#v2listsingleprop]+V2 API Get single property value on an alias::++====-[.tab-label]*V2 API* Get single property value on an alias-[source,bash]----curl -X GET http://localhost:8983/api/aliases/techproducts_alias/properties/foo@@ -816,34 +799,32 @@ curl -X GET http://localhost:8983/api/aliases/techproducts_alias/properties/foo}----====---+======[[deletealias]]== DELETEALIAS: Delete a Collection Alias-[.dynamic-tabs]----[example.tab-pane#v1deletealias]+[tabs#deletealias-request]+======+V1 API::++====-[.tab-label]*V1 API*-[source,bash]----http://localhost:8983/solr/admin/collections?action=DELETEALIAS&name=testalias----====-[example.tab-pane#v2deletealias]+V2 API::++====-[.tab-label]*V2 API*-[source,bash]----curl -X DELETE http://localhost:8983/api/aliases/testalias----====---+========= DELETEALIAS Parametersdiff --git a/solr/solr-ref-guide/modules/deployment-guide/pages/backup-restore.adoc b/solr/solr-ref-guide/modules/deployment-guide/pages/backup-restore.adocindex 96ed08f8c95..57d874ef932 100644--- a/solr/solr-ref-guide/modules/deployment-guide/pages/backup-restore.adoc+++ b/solr/solr-ref-guide/modules/deployment-guide/pages/backup-restore.adoc@@ -1,4 +1,5 @@= Backup and Restore+:tabs-sync-option:// Licensed to the Apache Software Foundation (ASF) under one// or more contributor license agreements. See the NOTICE file// distributed with this work for additional information@@ -242,12 +243,11 @@ The index files are snapshotted in the same index directory and can be referenceYou can trigger a snapshot command with an HTTP command like this (replace "techproducts" with the name of the core you are working with):-[.dynamic-tabs]----[example.tab-pane#v1createsnapshot]+[tabs#createsnapshot]+======+V1 API::++====-[.tab-label]*V1 API*-[source,bash]----curl -X POST http://localhost:8983/solr/admin/cores?action=CREATESNAPSHOT&core=techproducts&commitName=commit1@@ -255,10 +255,9 @@ curl -X POST http://localhost:8983/solr/admin/cores?action=CREATESNAPSHOT&core=t----====-[example.tab-pane#v2createsnapshot]+V2 API::++====-[.tab-label]*V2 API*-With the v2 API, the core and snapshot names are part of the path instead of query parameters.[source,bash]@@ -266,7 +265,7 @@ With the v2 API, the core and snapshot names are part of the path instead of quecurl -X POST http://localhost:8983/api/cores/techproducts/snapshots/commit1----====---+========= CREATE Parameters@@ -291,12 +290,11 @@ If the status is anything other than "success", an error message will explain whYou can trigger a list snapshot command with an HTTP command like this (replace "techproducts" with the name of the core you are working with):-[.dynamic-tabs]----[example.tab-pane#v1listsnapshots]+[tabs#listsnapshots]+======+V1 API::++====-[.tab-label]*V1 API*-[source,bash]----curl http://localhost:8983/solr/admin/cores?action=LISTSNAPSHOTS&core=techproducts&commitName=commit1@@ -304,10 +302,9 @@ curl http://localhost:8983/solr/admin/cores?action=LISTSNAPSHOTS&core=techproduc----====-[example.tab-pane#v2listsnapshots]+V2 API::++====-[.tab-label]*V2 API*-With the v2 API the core name appears in the path, instead of as a query parameter.[source,bash]@@ -315,7 +312,7 @@ With the v2 API the core name appears in the path, instead of as a query parametcurl http://localhost:8983/api/cores/techproducts/snapshots----====---+========= LIST Parameters@@ -340,12 +337,11 @@ If the status is anything other than "success", an error message will explain whYou can trigger a delete snapshot with an HTTP command like this (replace "techproducts" with the name of the core you are working with):-[.dynamic-tabs]----[example.tab-pane#v1deletesnapshot]+[tabs#deletesnapshot]+======+V1 API::++====-[.tab-label]*V1 API*-[source,bash]----curl http://localhost:8983/solr/admin/cores?action=DELETESNAPSHOT&core=techproducts&commitName=commit1@@ -353,10 +349,9 @@ curl http://localhost:8983/solr/admin/cores?action=DELETESNAPSHOT&core=techprodu----====-[example.tab-pane#v2deletesnapshot]+V2 API::++====-[.tab-label]*V2 API*-With the v2 API, the core and snapshot names are part of the path instead of query parameters.[source,bash]@@ -364,7 +359,7 @@ With the v2 API, the core and snapshot names are part of the path instead of quecurl -X DELETE http://localhost:8983/api/cores/techproducts/snapshots/commit1----====---+========= DELETE Parametersdiff --git a/solr/solr-ref-guide/modules/deployment-guide/pages/basic-authentication-plugin.adoc b/solr/solr-ref-guide/modules/deployment-guide/pages/basic-authentication-plugin.adocindex e878e902459..662f0a3bd59 100644--- a/solr/solr-ref-guide/modules/deployment-guide/pages/basic-authentication-plugin.adoc+++ b/solr/solr-ref-guide/modules/deployment-guide/pages/basic-authentication-plugin.adoc@@ -1,4 +1,5 @@= Basic Authentication Plugin+:tabs-sync-option:// Licensed to the Apache Software Foundation (ASF) under one// or more contributor license agreements. See the NOTICE file// distributed with this work for additional information@@ -151,27 +152,26 @@ If users need to be restricted to a specific collection, that can be done with tThe `set-user` command allows you to add users and change their passwords.For example, the following defines two users and their passwords:-[.dynamic-tabs]----[example.tab-pane#v1set-user]+[tabs#set-user]+======+V1 API::++====-[.tab-label]*V1 API*-[source,bash]----curl --user solr:SolrRocks http://localhost:8983/solr/admin/authentication -H 'Content-type:application/json' -d '{"set-user": {"tom":"TomIsCool", "harry":"HarrysSecret"}}'----====-[example.tab-pane#v2set-user]+V2 API::++====-[.tab-label]*V2 API*[source,bash]----curl --user solr:SolrRocks http://localhost:8983/api/cluster/security/authentication -H 'Content-type:application/json' -d '{"set-user": {"tom":"TomIsCool", "harry":"HarrysSecret"}}'----====---+========= Delete a User@@ -179,80 +179,76 @@ The `delete-user` command allows you to remove a user.The user password does not need to be sent to remove a user.In the following example, we've asked that user IDs 'tom' and 'harry' be removed from the system.-[.dynamic-tabs]----[example.tab-pane#v1delete-user]+[tabs#delete-user]+======+V1 API::++====-[.tab-label]*V1 API*[source,bash]----curl --user solr:SolrRocks http://localhost:8983/solr/admin/authentication -H 'Content-type:application/json' -d '{"delete-user": ["tom", "harry"]}'----====-[example.tab-pane#v2delete-user]+V2 API::++====-[.tab-label]*V2 API*[source,bash]----curl --user solr:SolrRocks http://localhost:8983/api/cluster/security/authentication -H 'Content-type:application/json' -d '{"delete-user": ["tom", "harry"]}'----====---+========= Set a PropertySet properties for the authentication plugin.The currently supported properties for the Basic Authentication plugin are `blockUnknown`, `realm`, and `forwardCredentials`.-[.dynamic-tabs]----[example.tab-pane#v1set-property-blockUnknown]+[tabs#set-property-blockUnknown]+======+V1 API::++====-[.tab-label]*V1 API*-[source,bash]----curl --user solr:SolrRocks http://localhost:8983/solr/admin/authentication -H 'Content-type:application/json' -d '{"set-property": {"blockUnknown":false}}'----====-[example.tab-pane#v2set-property-blockUnknown]+V2 API::++====-[.tab-label]*V2 API*-[source,bash]----curl --user solr:SolrRocks http://localhost:8983/api/cluster/security/authentication -H 'Content-type:application/json' -d '{"set-property": {"blockUnknown":false}}'----====---+======The authentication realm defaults to `solr` and is displayed in the `WWW-Authenticate` HTTP header and in the Admin UI login page.To change the realm, set the `realm` property:-[.dynamic-tabs]----[example.tab-pane#v1set-property-realm]+[tabs#set-property-realm]+======+V1 API::++====-[.tab-label]*V1 API*-[source,bash]----curl --user solr:SolrRocks http://localhost:8983/solr/admin/authentication -H 'Content-type:application/json' -d '{"set-property": {"realm":"My Solr users"}}'----====-[example.tab-pane#v2set-property-realm]+V2 API::++====-[.tab-label]*V2 API*-[source,bash]----curl --user solr:SolrRocks http://localhost:8983/api/cluster/security/authentication -H 'Content-type:application/json' -d '{"set-property": {"realm":"My Solr users"}}'----====---+========= Edit Plugin Configuration Using the MultiAuthPlugindiff --git a/solr/solr-ref-guide/modules/deployment-guide/pages/cluster-node-management.adoc b/solr/solr-ref-guide/modules/deployment-guide/pages/cluster-node-management.adocindex 1274943be59..2b60644c42b 100644--- a/solr/solr-ref-guide/modules/deployment-guide/pages/cluster-node-management.adoc+++ b/solr/solr-ref-guide/modules/deployment-guide/pages/cluster-node-management.adoc@@ -1,4 +1,5 @@= Cluster and Node Management Commands+:tabs-sync-option::toclevels: 1// Licensed to the Apache Software Foundation (ASF) under one// or more contributor license agreements. See the NOTICE file@@ -43,12 +44,11 @@ No active replicas *OR* there's no shard leader.The collection health state is reported as the worst state of any shard, e.g., for a collection with all shards GREEN except for one YELLOW the collection health will be reported as YELLOW.-[.dynamic-tabs]----[example.tab-pane#v1clusterstatus]+[tabs#clusterstatus-request]+======+V1 API::++====-[.tab-label]*V1 API*-[source,bash]----http://localhost:8983/solr/admin/collections?action=CLUSTERSTATUS@@ -56,17 +56,16 @@ http://localhost:8983/solr/admin/collections?action=CLUSTERSTATUS----====-[example.tab-pane#v2clusterstatus]+V2 API::++====-[.tab-label]*V2 API*-[source,bash]----curl -X GET http://localhost:8983/api/cluster----====---+========= CLUSTERSTATUS Parameters@@ -187,12 +186,11 @@ http://localhost:8983/solr/admin/collections?action=CLUSTERSTATUSAdd, edit or delete a cluster-wide property.-[.dynamic-tabs]----[example.tab-pane#v1clusterprop]+[tabs#clusterprop-request]+======+V1 API::++====-[.tab-label]*V1 API*-[source,bash]----http://localhost:8983/solr/admin/collections?action=CLUSTERPROP&name=urlScheme&val=https@@ -200,10 +198,9 @@ http://localhost:8983/solr/admin/collections?action=CLUSTERPROP&name=urlScheme&v----====-[example.tab-pane#v2clusterprop]+V2 API::++====-[.tab-label]*V2 API*-[source,bash]----curl -X POST http://localhost:8983/api/cluster -H 'Content-Type: application/json' -d '@@ -216,8 +213,7 @@ curl -X POST http://localhost:8983/api/cluster -H 'Content-Type: application/jso'----====----+========= CLUSTERPROP Parameters@@ -275,20 +271,17 @@ http://localhost:8983/solr/admin/collections?action=CLUSTERPROP&name=urlScheme&vIt is possible to set cluster-wide default values for certain attributes of a collection, using the `defaults` parameter.*Set/update default values*-[.dynamic-tabs]----[example.tab-pane#v1setobjproperty]+[tabs#setobjproperty-request]+======+V1 API::++====-[.tab-label]*V1 API*-There is no V1 equivalent of this action.====--[example.tab-pane#v2setobjproperty]+V2 API::++====-[.tab-label]*V2 API*-[source,bash]----curl -X POST -H 'Content-type:application/json' --data-binary '@@ -306,9 +299,7 @@ curl -X POST -H 'Content-type:application/json' --data-binary '}' http://localhost:8983/api/cluster----====-----+======*Unset the only value of `nrtReplicas`*@@ -366,10 +357,11 @@ will be used to decide:* Which nodes those replicas should be placed* When the cluster has reached an "equilibrium"-[example.tab-pane#v2balancereplicas]+[tabs#balancereplicas-request]+======+V2 API::++====-[.tab-label]*V2 API*-[source,bash]----curl -X POST http://localhost:8983/api/cluster/replicas/balance -H 'Content-Type: application/json' -d '@@ -380,6 +372,7 @@ curl -X POST http://localhost:8983/api/cluster/replicas/balance -H 'Content-Type'----====+========= Parameters@@ -433,12 +426,11 @@ Ensures that a particular property is distributed evenly amongst the physical noIf the property already exists on a replica, every effort is made to leave it there.If the property is *not* on any replica on a shard, one is chosen and the property is added.-[.dynamic-tabs]----[example.tab-pane#v1balanceshardunique]+[tabs#balanceshardunique-request]+======+V1 API::++====-[.tab-label]*V1 API*-[source,bash]----http://localhost:8983/solr/admin/collections?action=BALANCESHARDUNIQUE&collection=techproducts&property=preferredLeader@@ -446,10 +438,9 @@ http://localhost:8983/solr/admin/collections?action=BALANCESHARDUNIQUE&collectio----====-[example.tab-pane#v2balanceshardunique]+V2 API::++====-[.tab-label]*V2 API*-[source,bash]----curl -X POST http://localhost:8983/api/collections/techproducts/balance-shard-unique -H 'Content-Type: application/json' -d '@@ -459,7 +450,7 @@ curl -X POST http://localhost:8983/api/collections/techproducts/balance-shard-un'----====---+========= BALANCESHARDUNIQUE Parameters@@ -544,10 +535,11 @@ If more than one node is used as a targetNode (either explicitly, or by default)xref:configuration-guide:replica-placement-plugins.adoc[Replica Placement Plugin] will be used to determinewhich targetNode should be used for each migrated replica.-[example.tab-pane#v2migratereplicas]+[tabs#migratereplicas-request]+======+V2 API::++====-[.tab-label]*V2 API*-[source,bash]----curl -X POST http://localhost:8983/api/cluster/replicas/migrate -H 'Content-Type: application/json' -d '@@ -559,6 +551,7 @@ curl -X POST http://localhost:8983/api/cluster/replicas/migrate -H 'Content-Type'----====+========= Parameters@@ -633,12 +626,11 @@ If no targetNode is provided, then the configuredxref:configuration-guide:replica-placement-plugins.adoc[Replica Placement Plugin] will be used to determinewhich node each recreated replica should be placed on.-[.dynamic-tabs]----[example.tab-pane#v1replacenode]+[tabs#replacenode-request]+======+V1 API::++====-[.tab-label]*V1 API*-[source,bash]----http://localhost:8983/solr/admin/collections?action=REPLACENODE&sourceNode=source-node&targetNode=target-node@@ -646,10 +638,9 @@ http://localhost:8983/solr/admin/collections?action=REPLACENODE&sourceNode=sourc----====-[example.tab-pane#v2replacenode]+V2 API::++====-[.tab-label]*V2 API*-[source,bash]----curl -X POST "http://localhost:8983/api/cluster/nodes/localhost:7574_solr/replace" -H 'Content-Type: application/json' -d '@@ -660,9 +651,8 @@ curl -X POST "http://localhost:8983/api/cluster/nodes/localhost:7574_solr/replac}'-----====---+========= REPLACENODE Parameters@@ -736,12 +726,12 @@ So don't perform other collection operations in this period.Deletes all replicas of all collections in that node.Please note that the node itself will remain as a live node after this operation.-[.dynamic-tabs]----[example.tab-pane#v1deletenode]-====-[.tab-label]*V1 API*+[tabs#deletenode-request]+======+V1 API::+++====[source,bash]----http://localhost:8983/solr/admin/collections?action=DELETENODE&node=nodeName@@ -749,10 +739,9 @@ http://localhost:8983/solr/admin/collections?action=DELETENODE&node=nodeName----====-[example.tab-pane#v2deletenode]+V2 API::++====-[.tab-label]*V2 API*-[source,bash]----curl -X POST "http://localhost:8983/api/cluster/nodes/localhost:7574_solr/clear/" -H 'Content-Type: application/json' -d '@@ -761,9 +750,8 @@ curl -X POST "http://localhost:8983/api/cluster/nodes/localhost:7574_solr/clear/}'-----====---+========= DELETENODE Parameters@@ -797,12 +785,11 @@ This is useful in large clusters where an Overseer is likely to get overloaded.If available, one among the list of nodes which are assigned the 'overseer' role would become the overseer.The system would assign the role to any other node if none of the designated nodes are up and running.-[.dynamic-tabs]----[example.tab-pane#v1addrole]+[tabs#addrole-request]+======+V1 API::++====-[.tab-label]*V1 API*-[source,bash]----http://localhost:8983/solr/admin/collections?action=ADDROLE&role=overseer&node=localhost:8983_solr@@ -810,10 +797,9 @@ http://localhost:8983/solr/admin/collections?action=ADDROLE&role=overseer&node=l----====-[example.tab-pane#v2addrole]+V2 API::++====-[.tab-label]*V2 API*-[source,bash]----curl -X POST http://localhost:8983/api/cluster -H 'Content-Type: application/json' -d '@@ -826,7 +812,7 @@ curl -X POST http://localhost:8983/api/cluster -H 'Content-Type: application/jso'----====---+========= ADDROLE Parameters@@ -882,12 +868,11 @@ http://localhost:8983/solr/admin/collections?action=ADDROLE&role=overseer&node=1Remove an assigned role.This API is used to undo the roles assigned using ADDROLE operation-[.dynamic-tabs]----[example.tab-pane#v1removerole]+[tabs#removerole-request]+======+V1 API::++====-[.tab-label]*V1 API*-[source,bash]----http://localhost:8983/solr/admin/collections?action=REMOVEROLE&role=overseer&node=localhost:8983_solr@@ -895,10 +880,9 @@ http://localhost:8983/solr/admin/collections?action=REMOVEROLE&role=overseer&nod----====-[example.tab-pane#v2removerole]+V2 API::++====-[.tab-label]*V2 API*-[source,bash]----curl -X POST http://localhost:8983/api/cluster -H 'Content-Type: application/json' -d '@@ -911,7 +895,7 @@ curl -X POST http://localhost:8983/api/cluster -H 'Content-Type: application/jso'----====---+========= REMOVEROLE Parameters@@ -966,12 +950,11 @@ http://localhost:8983/solr/admin/collections?action=REMOVEROLE&role=overseer&nodReturns the current status of the overseer, performance statistics of various overseer APIs, and the last 10 failures per operation type.-[.dynamic-tabs]----[example.tab-pane#v1overseerstatus]+[tabs#overseerstatus-request]+======+V1 API::++====-[.tab-label]*V1 API*-[source,bash]----http://localhost:8983/solr/admin/collections?action=OVERSEERSTATUS@@ -979,16 +962,15 @@ http://localhost:8983/solr/admin/collections?action=OVERSEERSTATUS----====-[example.tab-pane#v2overseerstatus]+V2 API::++====-[.tab-label]*V2 API*-[source,bash]----curl -X GET http://localhost:8983/api/cluster/overseer----====---+========= Examples using OVERSEERSTATUSdiff --git a/solr/solr-ref-guide/modules/deployment-guide/pages/collection-management.adoc b/solr/solr-ref-guide/modules/deployment-guide/pages/collection-management.adocindex d955152c206..8c6b6e2bc76 100644--- a/solr/solr-ref-guide/modules/deployment-guide/pages/collection-management.adoc+++ b/solr/solr-ref-guide/modules/deployment-guide/pages/collection-management.adoc@@ -1,4 +1,5 @@= Collection Management Commands+:tabs-sync-option::toclevels: 1// Licensed to the Apache Software Foundation (ASF) under one// or more contributor license agreements. See the NOTICE file@@ -31,12 +32,11 @@ bin/solr start -c -e techproductsThe CREATE action is used to create new collection of data.-[.dynamic-tabs]----[example.tab-pane#v1createcollection]+[tabs#createcollection]+======+V1 API::++====-[.tab-label]*V1 API*-[source,bash]----http://localhost:8983/solr/admin/collections?action=CREATE&name=techproducts_v2&collection.configName=techproducts&numShards=1@@ -44,10 +44,9 @@ http://localhost:8983/solr/admin/collections?action=CREATE&name=techproducts_v2&----====-[example.tab-pane#v2createcollection]+V2 API::++====-[.tab-label]*V2 API*-With the v2 API, the `create` command is provided as part of the JSON data that contains the required parameters:[source,bash]@@ -61,7 +60,7 @@ curl -X POST http://localhost:8983/api/collections -H 'Content-Type: application'----====---+========= CREATE Parameters@@ -305,12 +304,11 @@ Solr automatically reloads collections when certain files, monitored via a watchsuch as `security.json`.However, for changes to files in configsets, like uploading a new schema, you will need to manually trigger the RELOAD.-[.dynamic-tabs]----[example.tab-pane#v1reloadcollection]+[tabs#reloadcollection-request]+======+V1 API::++====-[.tab-label]*V1 API*-[source,bash]----http://localhost:8983/solr/admin/collections?action=RELOAD&name=techproducts_v2@@ -318,10 +316,9 @@ http://localhost:8983/solr/admin/collections?action=RELOAD&name=techproducts_v2----====-[example.tab-pane#v2reloadcollection]+V2 API::++====-[.tab-label]*V2 API*-With the v2 API, the `reload` command is provided as a part of URL path. The request body is optional if the optional `async` parameter is omitted:[source,bash]@@ -332,7 +329,7 @@ curl -X POST http://localhost:8983/api/collections/techproducts_v2/reload -H 'Co}----====---+========= RELOAD Parameters@@ -371,12 +368,11 @@ For instance, increasing `replicationFactor` will _not_ automatically add more rAn attribute can be deleted by passing an empty value.For example, `yet_another_attribute_name=` (with no value) will delete the `yet_another_attribute_name` parameter from the collection.-[.dynamic-tabs]----[example.tab-pane#v1modifycollection]+[tabs#modifycollection-request]+======+V1 API::++====-[.tab-label]*V1 API*-[source,bash]----http://localhost:8983/solr/admin/collections?action=MODIFYCOLLECTION&collection=techproducts_v2&<attribute-name>=<attribute-value>&<another-attribute-name>=<another-value>&<yet_another_attribute_name>=@@ -385,11 +381,9 @@ http://localhost:8983/solr/admin/collections?action=modifycollection&collection=----====--[example.tab-pane#v2modifycollection]+V2 API::++====-[.tab-label]*V2 API*-With the v2 API, the `modify` command is provided as part of the JSON data that contains the required parameters:[source,bash]@@ -403,9 +397,7 @@ curl -X POST http://localhost:8983/api/collections/techproducts_v2 -H 'Content-T'----====-----+========= MODIFYCOLLECTION Parameters@@ -469,22 +461,20 @@ Removing the `readOnly` property or setting it to false enables the processing oFetch the names of the collections in the cluster.-[.dynamic-tabs]----[example.tab-pane#v1listcollection]+[tabs#listcollection-request]+======+V1 API::++====-[.tab-label]*V1 API*-[source,bash]----http://localhost:8983/solr/admin/collections?action=LIST----====-[example.tab-pane#v2listcollection]+V2 API::++====-[.tab-label]*V2 API*-With the v2 API, the `list` command is provided as part of the JSON data that contains the required parameters:[source,bash]@@ -492,7 +482,7 @@ With the v2 API, the `list` command is provided as part of the JSON data that cocurl -X GET http://localhost:8983/api/collections----====---+======*Output*@@ -522,22 +512,20 @@ Aliases that refer to more than 1 collection are not supported.* the existing name must not be a Routed Alias.* the target name must not be an existing alias.-[.dynamic-tabs]----[example.tab-pane#v1renamecollection]+[tabs#renamecollection-request]+======+V1 API::++====-[.tab-label]*V1 API*-[source,bash]----http://localhost:8983/solr/admin/collections?action=RENAME&name=techproducts_v2&target=newName----====-[example.tab-pane#v2renamecollection]+V2 API::++====-[.tab-label]*V2 API*-[source,bash]----curl -X POST http://localhost:8983/api/collections/techproducts/rename -H 'Content-Type: application/json' -d '@@ -547,8 +535,7 @@ curl -X POST http://localhost:8983/api/collections/techproducts/rename -H 'Conte'----====----+========= RENAME Command Parameters@@ -603,23 +590,19 @@ an actual collection name) the following aliases will exist now:The DELETE action is used to delete a collection.-[.dynamic-tabs]----[example.tab-pane#v1deletecollection]+[tabs#deletecollection-request]+======+V1 API::++====-[.tab-label]*V1 API*-[source,bash]----http://localhost:8983/solr/admin/collections?action=DELETE&name=techproducts_v2----====--[example.tab-pane#v2deletecollection]+V2 API::++====-[.tab-label]*V2 API*--[source,bash]----curl -X DELETE http://localhost:8983/api/collections/techproducts_v2@@ -632,7 +615,7 @@ To run a DELETE asynchronously then append the `async` parameter:curl -X DELETE http://localhost:8983/api/collections/techproducts_v2?async=aaaa----====---+========= DELETE Parameters@@ -690,22 +673,20 @@ If the status is anything other than "success", an error message will explain whAdd, edit or delete a collection property.-[.dynamic-tabs]----[example.tab-pane#v1collectionproperty]+[tabs#collectionproperty-request]+======+V1 API::++====-[.tab-label]*V1 API*-[source,bash]----http://localhost:8983/solr/admin/collections?action=COLLECTIONPROP&name=techproducts_v2&propertyName=propertyName&propertyValue=propertyValue----====-[example.tab-pane#v2collectionproperty]+V2 API::++====-[.tab-label]*V2 API*-To create or update a collection property:[source,bash]----@@ -723,7 +704,7 @@ To delete an existing collection property:curl -X DELETE http://localhost:8983/api/collections/techproducts_v2/properties/foo----====---+========= COLLECTIONPROP Parameters@@ -769,23 +750,20 @@ The MIGRATE command is used to migrate all documents having a given routing keyThe source collection will continue to have the same data as-is but it will start re-routing write requests to the target collection for the number of seconds specified by the `forward.timeout` parameter.It is the responsibility of the user to switch to the target collection for reads and writes after the MIGRATE action completes.-[.dynamic-tabs]----[example.tab-pane#v1migratecollection]+[tabs#migratecollection-request]+======+V1 API::++====-[.tab-label]*V1 API*-[source,bash]----http://localhost:8983/solr/admin/collections?action=MIGRATE&collection=techproducts_v2&split.key=key1!&target.collection=postMigrationCollection&forward.timeout=60----====-[example.tab-pane#v2migratecollection]+V2 API::++====-[.tab-label]*V2 API*--[source,bash]----curl -X POST http://localhost:8983/api/collections/techproducts_v2 -H 'Content-Type: application/json' -d '@@ -798,7 +776,7 @@ curl -X POST http://localhost:8983/api/collections/techproducts_v2 -H 'Content-T'----====---+======The routing key specified by the `split.key` parameter may span multiple shards on both the source and the target collections.The migration is performed shard-by-shard in a single thread.@@ -882,26 +860,24 @@ The response will include the status of the request.The REINDEXCOLLECTION command reindexes a collection using existing data from thesource collection.-[.dynamic-tabs]----[example.tab-pane#v1reindexcollection]+[tabs#reindexcollection-request]+======+V1 API::++====-[.tab-label]*V1 API*-[source,bash]----http://localhost:8983/solr/admin/collections?action=REINDEXCOLLECTION&name=techproducts_v2----====-[example.tab-pane#v2reindexcollection]+V2 API::++====-[.tab-label]*V2 API*-We do not currently have a V2 equivalent.====---+======NOTE: Reindexing is potentially a lossy operation.Some of the existing indexed data that is not available as stored fields may be lost, so users should use this command with caution, evaluating the potential impact by using different source and target collection names first, and preserving the source collection until the evaluation is complete.@@ -1059,22 +1035,20 @@ The status also shows that the source collection was already an alias to `.rx_teThe COLSTATUS command provides a detailed description of the collection status, including low-level index information about segments and field data.There isn't a good equivalent V2 API that supports all the parameters below.-[.dynamic-tabs]----[example.tab-pane#v1collectionstatus]+[tabs#collectionstatus-request]+======+V1 API::++====-[.tab-label]*V1 API*-[source,bash]----http://localhost:8983/solr/admin/collections?action=COLSTATUS&collection=techproducts_v2&coreInfo=true&segments=true&fieldInfo=true&sizeInfo=true----====-[example.tab-pane#v2collectionstatus]+V2 API::++====-[.tab-label]*V2 API*-The closest V2 API is this one, but doesn't support all the features of the V1 equivalent.[source,bash]@@ -1082,7 +1056,7 @@ The closest V2 API is this one, but doesn't support all the features of the V1 ecurl -X GET http://localhost:8983/api/collections/techproducts_v2----====---+======This command also checks the compliance of Lucene index field types with the current Solr collection schema and indicates the names of non-compliant fields, i.e., Lucene fields with field types incompatible (or different) from the corresponding Solr field types declared in the current schema.Such incompatibilities may result from incompatible schema changes or after migration of data to a different major Solr release.@@ -1548,12 +1522,11 @@ http://localhost:8983/solr/admin/collections?action=COLSTATUS&collection=gettingBacks up Solr collections and associated configurations to a "backup repository".-[.dynamic-tabs]----[example.tab-pane#v1backupcollection]+[tabs#backupcollection-request]+======+V1 API::++====-[.tab-label]*V1 API*-[source,bash]----http://localhost:8983/solr/admin/collections?action=BACKUP&name=techproducts_backup&collection=techproducts&location=file:///path/to/my/shared/drive@@ -1561,10 +1534,9 @@ http://localhost:8983/solr/admin/collections?action=BACKUP&name=techproducts_bac----====-[example.tab-pane#v2backupcollection]+V2 API::++====-[.tab-label]*V2 API*-[source,bash]----curl -X POST http://localhost:8983/api/collections/techproducts/backups/techproducts_backup/versions -H 'Content-Type: application/json' -d '@@ -1574,7 +1546,7 @@ curl -X POST http://localhost:8983/api/collections/techproducts/backups/techprod'----====---+======The BACKUP API will backup Solr indexes and configurations for a specified collection.The BACKUP command xref:backup-restore.adoc[takes one copy from each shard for the indexes].@@ -1714,10 +1686,11 @@ Valid options are `copy-files` (which backs up both the collection configset andThe name of the collection "snapshot" to create a backup from.If not provided, Solr will create the backup from the current collection state (instead of a previous snapshotted state).-[example.tab-pane#backup-response-incremental]+[tabs#backup-response-incremental]+======+Incremental Backup Response::++====-[.tab-label]*Incremental Backup Response*-[source,json]----{@@ -1740,6 +1713,7 @@ If not provided, Solr will create the backup from the current collection state (}----====+======[[listbackup]]== LISTBACKUP: List Backups@@ -1808,28 +1782,25 @@ Request ID to track this action which will be xref:configuration-guide:collectio*Input*-[.dynamic-tabs]----[example.tab-pane#v1listbackup]+[tabs#listbackup-request]+======+V1 API::++====-[.tab-label]*V1 API*-[source,bash]----http://localhost:8983/solr/admin/collections?action=LISTBACKUP&name=myBackupName&location=/path/to/my/shared/drive----====--[example.tab-pane#v2listbackup]+V2 API::++====-[.tab-label]*V2 API*-[source,bash]----curl -X GET "http://localhost:8983/api/backups/backupName/versions?location=/path/to/my/shared/drive"----====---+======*Output*@@ -1869,12 +1840,11 @@ curl -X GET "http://localhost:8983/api/backups/backupName/versions?location=/patRestores Solr indexes and associated configurations to a specified collection.-[.dynamic-tabs]----[example.tab-pane#v1restorecollection]+[tabs#restorecollection-request]+======+V1 API::++====-[.tab-label]*V1 API*-[source,bash]----curl -X GET http://localhost:8983/solr/admin/collections?action=RESTORE&name=techproducts_backup&location=file:///path/to/my/shared/drive&collection=techproducts_v3&nrtReplicas=2&createNodeSet=node1,node2&property.foo=bar@@ -1882,10 +1852,9 @@ curl -X GET http://localhost:8983/solr/admin/collections?action=RESTORE&name=tec----====-[example.tab-pane#v2restorecollection]+V2 API::++====-[.tab-label]*V2 API*-[source,bash]----curl -X POST http://localhost:8983/api/backups/techproducts_backup/restore -H 'Content-Type: application/json' -d '@@ -1903,7 +1872,7 @@ curl -X POST http://localhost:8983/api/backups/techproducts_backup/restore -H 'C'----====---+======The RESTORE operation will replace the content of a collection with files from the specified backup.@@ -2018,28 +1987,26 @@ See the examples and parameter descriptions below for more information.*Input*-[.dynamic-tabs]----[example.tab-pane#v1deletebackupsingle]+[tabs#deletebackupsingle-request]+======+V1 API::++====-[.tab-label]*V1 API*-[source,bash]----http://localhost:8983/solr/admin/collections?action=DELETEBACKUP&name=myBackupName&location=/path/to/my/shared/drive&backupId=0----====-[example.tab-pane#v2deletebackupsingle]+V2 API::++====-[.tab-label]*V2 API*-[source,bash]----curl -X DELETE "http://localhost:8983/api/backups/myBackupName/versions/0?location=/path/to/my/shared/drive"----====---+======*Output*@@ -2059,48 +2026,44 @@ curl -X DELETE "http://localhost:8983/api/backups/myBackupName/versions/0?locati==== Deleting all but N recent backups-[.dynamic-tabs]----[example.tab-pane#v1deletebackupmulti]+[tabs#deletebackupmulti-request]+======+V1 API::++====-[.tab-label]*V1 API*-[source,bash]----http://localhost:8983/solr/admin/collections?action=DELETEBACKUP&name=myBackupName&location=/path/to/my/shared/drive&maxNumBackupsPoints=2----====-[example.tab-pane#v2deletebackupmulti]+V2 API::++====-[.tab-label]*V2 API*-[source,bash]----curl -X DELETE "http://localhost:8983/api/backups/myBackupName/versions?retainLatest=2&location=/path/to/my/shared/drive"----====---+========== "Garbage collecting" unused files-[.dynamic-tabs]----[example.tab-pane#v1deletebackupgc]+[tabs#deletebackupgc-request]+======+V1 API::++====-[.tab-label]*V1 API*-[source,bash]----http://localhost:8983/solr/admin/collections?action=DELETEBACKUP&name=myBackupName&location=/path/to/my/shared/drive&purgeUnused=true----====-[example.tab-pane#v2deletebackupgc]+V2 API::++====-[.tab-label]*V2 API*-[source,bash]----@@ -2111,7 +2074,7 @@ curl -X PUT -H "Content-type: application/json" "http://localhost:8983/api/backu'----====---+========= DELETEBACKUP Parameters@@ -2198,12 +2161,11 @@ Request ID to track this action which will be xref:configuration-guide:collectioReassigns leaders in a collection according to the preferredLeader property across active nodes.-[.dynamic-tabs]----[example.tab-pane#v1rebalanceleaders]+[tabs#rebalanceleaders-request]+======+V1 API::++====-[.tab-label]*V1 API*-[source,bash]----http://localhost:8983/solr/admin/collections?action=REBALANCELEADERS&collection=techproducts@@ -2211,10 +2173,9 @@ http://localhost:8983/solr/admin/collections?action=REBALANCELEADERS&collection=----====-[example.tab-pane#v2rebalanceleaders]+V2 API::++====-[.tab-label]*V2 API*-With the v2 API, the `rebalance-leaders` command is provided as part of the JSON data that contains the required parameters:[source,bash]@@ -2228,7 +2189,7 @@ curl -X POST http://localhost:8983/api/collections/techproducts -H 'Content-Type'----====---+======Leaders are assigned in a collection according to the `preferredLeader` property on active nodes.This command should be run after the preferredLeader property has been assigned via the BALANCESHARDUNIQUE or ADDREPLICAPROP commands.@@ -2341,22 +2302,20 @@ They provide less protection than backups, at a much cheaper cost.The following API command creates a snapshot of a specified collection.-[.dynamic-tabs]----[example.tab-pane#v1createsnapshot]+[tabs#createsnapshot-request]+======+V1 API::++====-[.tab-label]*V1 API*-[source,bash]----http://localhost:8983/solr/admin/collections?action=CREATESNAPSHOT&collection=techproducts&commitName=snapshot0&followAliases=true&async=someAsyncId----====-[example.tab-pane#v2createsnapshot]+V2 API::++====-[.tab-label]*V2 API*-[source,bash]----curl -X POST http://localhost:8983/api/collections/techproducts/snapshots/snapshot0 -H 'Content-Type: application/json' -d '@@ -2367,7 +2326,7 @@ curl -X POST http://localhost:8983/api/collections/techproducts/snapshots/snapsh'----====---+======*Output*@@ -2434,28 +2393,26 @@ Lists all the snapshots taken of a collection.The following API command lists all the snapshots taken of a collection.-[.dynamic-tabs]----[example.tab-pane#v1listsnapshots]+[tabs#listsnapshots-request]+======+V1 API::++====-[.tab-label]*V1 API*-[source,bash]----http://localhost:8983/solr/admin/collections?action=LISTSNAPSHOTS&collection=techproducts----====-[example.tab-pane#v2listsnapshots]+V2 API::++====-[.tab-label]*V2 API*-[source,bash]----curl -X GET http://localhost:8983/api/collections/techproducts/snapshots----====---+======*Output*@@ -2567,28 +2524,26 @@ Deletes a snapshot taken of a specified collection.The following API command deletes a snapshot taken of a collection.-[.dynamic-tabs]----[example.tab-pane#v1deletesnapshot]+[tabs#deletesnapshot-request]+======+V1 API::++====-[.tab-label]*V1 API*-[source,bash]----http://localhost:8983/solr/admin/collections?action=DELETESNAPSHOT&collection=techproducts&commitName=snapshot0&followAliases=true&async=someAsyncId----====-[example.tab-pane#v2deletesnapshot]+V2 API::++====-[.tab-label]*V2 API*-[source,bash]----curl -X DELETE http://localhost:8983/api/collections/techproducts/snapshots/snapshot0?followAliases=true&async=someAsyncId----====---+======*Output*diff --git a/solr/solr-ref-guide/modules/deployment-guide/pages/configuring-logging.adoc b/solr/solr-ref-guide/modules/deployment-guide/pages/configuring-logging.adocindex 706ca0d9de9..27f74d02fdb 100644--- a/solr/solr-ref-guide/modules/deployment-guide/pages/configuring-logging.adoc+++ b/solr/solr-ref-guide/modules/deployment-guide/pages/configuring-logging.adoc@@ -1,4 +1,5 @@= Configuring Logging+:tabs-sync-option:// Licensed to the Apache Software Foundation (ASF) under one// or more contributor license agreements. See the NOTICE file// distributed with this work for additional information@@ -76,22 +77,20 @@ There is also a way of sending REST commands to the `admin/info/logging` endpoinExample:-[.dynamic-tabs]----[example.tab-pane#v1createcollection]+[tabs#createcollection]+======+V1 API::++====-[.tab-label]*V1 API*-[source,bash]----curl -X GET "http://localhost:8983/solr/admin/info/logging?set=root:WARN"----====-[example.tab-pane#v2createcollection]+V2 API::++====-[.tab-label]*V2 API*-[source,bash]----curl -X PUT http://localhost:8983/api/node/logging/levels -H 'Content-Type: application/json' -d '@@ -101,7 +100,7 @@ curl -X PUT http://localhost:8983/api/node/logging/levels -H 'Content-Type: appl'----====---+========= Choosing Log Level at Startupdiff --git a/solr/solr-ref-guide/modules/deployment-guide/pages/enabling-ssl.adoc b/solr/solr-ref-guide/modules/deployment-guide/pages/enabling-ssl.adocindex b67760d3164..cae6b1cd1b6 100644--- a/solr/solr-ref-guide/modules/deployment-guide/pages/enabling-ssl.adoc+++ b/solr/solr-ref-guide/modules/deployment-guide/pages/enabling-ssl.adoc@@ -1,4 +1,5 @@= Enabling SSL+:tabs-sync-option:// Licensed to the Apache Software Foundation (ASF) under one// or more contributor license agreements. See the NOTICE file// distributed with this work for additional information@@ -66,14 +67,15 @@ $ openssl pkcs12 -nokeys -in solr-ssl.keystore.p12 -out solr-ssl.cacert.pemThe Solr Control Script is already setup to pass SSL-related Java system properties to the JVM.To activate the SSL settings, uncomment and update the set of properties beginning with `SOLR_SSL_*` in `bin/solr.in.sh` on *nix systems or `bin\solr.in.cmd` on Windows.-[.dynamic-tabs]----[example.tab-pane#solr-in-sh]+[tabs#solr-in]+======+*nix::++====-[.tab-label]**nix (solr.in.sh)*-NOTE: If you setup Solr as a service on Linux using the steps outlined in xref:taking-solr-to-production.adoc[], then make these changes in `/var/solr/solr.in.sh`.+.solr.in.sh+[source,bash]----# Enables HTTPS. It is implicitly true if you set SOLR_SSL_KEY_STORE. Use this config@@ -96,9 +98,10 @@ SOLR_SSL_CHECK_PEER_NAME=true----====-[example.tab-pane#solr-in-cmd]+Windows::++====-[.tab-label]*Windows (solr.in.cmd)*+.solr.in.cmd[source,powershell]----REM Enables HTTPS. It is implicitly true if you set SOLR_SSL_KEY_STORE. Use this config@@ -120,7 +123,7 @@ REM This will also be used for the default value of whether SNI Host checking shset SOLR_SSL_CHECK_PEER_NAME=true----====---+======.Client Authentication SettingsWARNING: Enable either `SOLR_SSL_NEED_CLIENT_AUTH` or `SOLR_SSL_WANT_CLIENT_AUTH` but not both at the same time.@@ -187,11 +190,12 @@ s|Required |Default: none+The password to the credential store.-[.dynamic-tabs]----[example.tab-pane#credstore-unix]+[tabs#credstore]+======+*nix::++====-[.tab-label]**nix (solr.in.sh)*+.solr.in.sh[source,bash]----SOLR_OPTS=" -Dsolr.ssl.credential.provider.chain=hadoop"@@ -200,17 +204,18 @@ HADOOP_CREDSTORE_PASSWORD="credStorePass123"----====-[example.tab-pane#credstore-windows]-=====-[.tab-label]*Windows (solr.in.cmd)*+Windows::+++====+.solr.in.cmd[source,powershell]----set SOLR_OPTS=" -Dsolr.ssl.credential.provider.chain=hadoop"set SOLR_HADOOP_CREDENTIAL_PROVIDER_PATH=localjceks://file/home/solr/hadoop-credential-provider.jceksset HADOOP_CREDSTORE_PASSWORD="credStorePass123"-----=====---+====+========= Configure ZooKeeper@@ -222,26 +227,26 @@ See xref:zookeeper-ensemble.adoc[] for more information.The `urlScheme` cluster-wide property needs to be set to `https` before any Solr node starts up.The examples below use the `zkcli` tool that comes with Solr to do this.-[.dynamic-tabs]----[example.tab-pane#zkclusterprops-unix]+[tabs#zkclusterprops]+======+*nix::++====-[.tab-label]**nix Command*[source,terminal]----$ bin/solr cluster -property urlSchema -value https -z server1:2181,server2:2181,server3:2181----====-[example.tab-pane#zkclusterprops-windows]-=====-[.tab-label]*Windows Command*+Windows::+++====[source,powershell]----C:\> bin/solr.cmd -property urlSchema -value https -z server1:2181,server2:2181,server3:2181-----=====---+====+======Be sure to use the correct `zkhost` value for your system.If you have set up your ZooKeeper ensemble to use a xref:taking-solr-to-production.adoc#zookeeper-chroot[chroot for Solr], make sure to include it in the `zkhost` string, e.g., `-zkhost server1:2181,server2:2181,server3:2181/solr`.@@ -268,26 +273,26 @@ Once this and all other steps are complete, you can go ahead and start Solr.Start Solr using the Solr control script as shown in the examples below.Customize the values for the parameters shown as needed and add any used in your system.-[.dynamic-tabs]----[example.tab-pane#single-unix]+[tabs#single]+======+*nix::++====-[.tab-label]**nix Command*[source,terminal]----$ bin/solr start -p 8984----====-[example.tab-pane#single-windows]+Windows::++====-[.tab-label]*Windows Command*[source,powershell]----C:\> bin\solr.cmd -p 8984----====---+========= Start SolrCloud@@ -298,27 +303,27 @@ Customize the values for the parameters shown as necessary and add any used in yIf you created the SSL key without all DNS names or IP addresses on which Solr nodes run, you can tell Solr to skip hostname verification for inter-node communications by setting the `-Dsolr.ssl.checkPeerName=false` system property.-[.dynamic-tabs]----[example.tab-pane#cloud-unix]+[tabs#cloud]+======+*nix::++====-[.tab-label]*\*nix*[source,terminal]----$ bin/solr start --cloud -s cloud/node1 -z server1:2181,server2:2181,server3:2181 -p 8984----====-[example.tab-pane#cloud-windows]+Windows::++====-[.tab-label]*Windows*[source,powershell]----C:\> bin\solr.cmd --cloud -s cloud\node1 -z server1:2181,server2:2181,server3:2181----====---+======== Automatically reloading KeyStore/TrustStore=== Solr Server@@ -359,17 +364,26 @@ NOTE: If your operating system does not include curl, you can download binariesCreate a 2-shard, replicationFactor=1 collection named mycollection using the `_default` configset:-.*nix command+[tabs]+======+*nix::+++====[source,bash]----bin/solr create -c mycollection --shards 2----+====-.Windows command+Windows::+++====[source,text]----bin\solr.cmd create -c mycollection --shards 2----+====+======The `create` action will pass the `SOLR_SSL_*` properties set in your include file to the SolrJ code used to create the collection.diff --git a/solr/solr-ref-guide/modules/deployment-guide/pages/jwt-authentication-plugin.adoc b/solr/solr-ref-guide/modules/deployment-guide/pages/jwt-authentication-plugin.adocindex 3667da302a1..aec5f269d24 100644--- a/solr/solr-ref-guide/modules/deployment-guide/pages/jwt-authentication-plugin.adoc+++ b/solr/solr-ref-guide/modules/deployment-guide/pages/jwt-authentication-plugin.adoc@@ -1,4 +1,5 @@= JWT Authentication Plugin+:tabs-sync-option:// Licensed to the Apache Software Foundation (ASF) under one// or more contributor license agreements. See the NOTICE file// distributed with this work for additional information@@ -215,12 +216,11 @@ Each of the configuration keys in the table above can be used as parameter keysExample:-[.dynamic-tabs]----[example.tab-pane#jwt-v1set-property]+[tabs#jwt-set-property]+======+V1 API::++====-[.tab-label]*V1 API*-[source,bash]----curl http://localhost:8983/solr/admin/authentication -H 'Content-type:application/json' -H 'Authorization: Bearer xxx.yyy.zzz' -d '{@@ -234,10 +234,9 @@ curl http://localhost:8983/solr/admin/authentication -H 'Content-type:applicatio----====-[example.tab-pane#jwt-v2set-property]+V2 API::++====-[.tab-label]*V2 API*-[source,bash]----curl http://localhost:8983/api/cluster/security/authentication -H 'Content-type:application/json' -H 'Authorization: Bearer xxx.yyy.zzz' -d '{@@ -250,7 +249,7 @@ curl http://localhost:8983/api/cluster/security/authentication -H 'Content-type:'----====---+======Insert a valid JWT access token in compact serialization format (`xxx.yyy.zzz` above) to authenticate with Solr once the plugin is active, or leave `blockUnknown=false` until configuration is complete and then switch it to `true` to start enforcing.diff --git a/solr/solr-ref-guide/modules/deployment-guide/pages/monitoring-with-prometheus-and-grafana.adoc b/solr/solr-ref-guide/modules/deployment-guide/pages/monitoring-with-prometheus-and-grafana.adocindex 9ce78463ca1..6ddec1fad9a 100644--- a/solr/solr-ref-guide/modules/deployment-guide/pages/monitoring-with-prometheus-and-grafana.adoc+++ b/solr/solr-ref-guide/modules/deployment-guide/pages/monitoring-with-prometheus-and-grafana.adoc@@ -1,4 +1,5 @@= Monitoring with Prometheus and Grafana+:tabs-sync-option:// Licensed to the Apache Software Foundation (ASF) under one// or more contributor license agreements. See the NOTICE file// distributed with this work for additional information@@ -52,12 +53,11 @@ The metrics exposed by `solr-exporter` can be seen at the metrics endpoint: `\htSee the commands below depending on your operating system and Solr operating mode:-[.dynamic-tabs]----[example.tab-pane#solr-exporter-linux]+[tabs#solr-exporter]+======+Linux::++====-[.tab-label]*Linux*-.User-managed / Single-node[source,bash]----@@ -73,10 +73,9 @@ $ ./bin/solr-exporter -p 9854 -z localhost:2181/solr -f ./conf/solr-exporter-con----====-[example.tab-pane#solr-exporter-windows]+Windows::++====-[.tab-label]*Windows*-.User-managed / Single-node[source,text]----@@ -91,7 +90,7 @@ $ ./bin/solr-exporter -p 9854 -z localhost:2181/solr -f ./conf/solr-exporter-con> .\bin\solr-exporter -p 9854 -z localhost:2181/solr -f .\conf\solr-exporter-config.xml -n 16----====---+========= Command Line Parametersdiff --git a/solr/solr-ref-guide/modules/deployment-guide/pages/replica-management.adoc b/solr/solr-ref-guide/modules/deployment-guide/pages/replica-management.adocindex 1d06eaa3f07..66e0408efe1 100644--- a/solr/solr-ref-guide/modules/deployment-guide/pages/replica-management.adoc+++ b/solr/solr-ref-guide/modules/deployment-guide/pages/replica-management.adoc@@ -1,4 +1,5 @@= Replica Management Commands+:tabs-sync-option::toclevels: 1// Licensed to the Apache Software Foundation (ASF) under one// or more contributor license agreements. See the NOTICE file@@ -35,13 +36,11 @@ Add one or more replicas to a shard in a collection.The node name can be specified if the replica is to be created in a specific node.Otherwise, a set of nodes can be specified and the most suitable ones among them will be chosen to create the replica(s).-[.dynamic-tabs]-----[example.tab-pane#v1addreplica]+[tabs#addreplica-request]+======+V1 API::++====-[.tab-label]*V1 API*-*Input*[source,text]@@ -66,9 +65,9 @@ http://localhost:8983/solr/admin/collections?action=ADDREPLICA&collection=techpr----====-[example.tab-pane#v2addreplica]+V2 API::++====-[.tab-label]*V2 API**Input*[source,bash]@@ -79,6 +78,7 @@ curl -X POST http://localhost:8983/api/collections/techproducts/shards/shard1/re}'----+*Output*[source,json]@@ -95,8 +95,7 @@ curl -X POST http://localhost:8983/api/collections/techproducts/shards/shard1/re"core":"techproducts_shard1_replica_n11"}}}----====----+========= ADDREPLICA Parameters@@ -304,13 +303,11 @@ In case of shared filesystems the `dataDir` will be reused.If this command is used on a collection where more than one replica from the same shard exists on the same node, and the `shard` and `sourceNode` parameters match more than one replica, the replica selected is not deterministic (currently it's random).-[.dynamic-tabs]-----[example.tab-pane#v1movereplica]+[tabs#movereplica-request]+======+V1 API::++====-[.tab-label]*V1 API*-*Input*[source,text]@@ -332,9 +329,9 @@ http://localhost:8983/solr/admin/collections?action=MOVEREPLICA&collection=test&----====-[example.tab-pane#v2movereplica]+V2 API::++====-[.tab-label]*V2 API**Input*[source,bash]@@ -348,6 +345,7 @@ curl -X POST http://localhost:8983/api/collections/techproducts -H 'Content-Type}'----+*Output*[source,json]@@ -361,7 +359,7 @@ curl -X POST http://localhost:8983/api/collections/techproducts -H 'Content-Type}----====---+========= MOVEREPLICA Parameters@@ -460,22 +458,20 @@ When deleting multiple replicas, Solr chooses replicas which are active, up to dFor 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.-[.dynamic-tabs]----[example.tab-pane#v1deletereplica]+[tabs#deletereplica-request]+======+V1 API::++====-[.tab-label]*V1 API*-[source,bash]----http://localhost:8983/solr/admin/collections?action=DELETEREPLICA&collection=techproducts&shard=shard1&replica=core_node2----====-[example.tab-pane#v2deletereplica]+V2 API::++====-[.tab-label]*V2 API*-The v2 API has three distinct endpoints for replica-deletion, depending on how the replicas are specified.To delete a replica by name:@@ -504,7 +500,7 @@ curl -X PUT -H "Content-type: application/json" "http://localhost:8983/api/colle'----====---+========= DELETEREPLICA Parameters@@ -620,13 +616,11 @@ Request ID to track this action which will be xref:configuration-guide:collectioAssign an arbitrary property to a particular replica and give it the value specified.If the property already exists, it will be overwritten with the new value.-[.dynamic-tabs]-----[example.tab-pane#v1addreplicaprop]+[tabs#addreplicaprop-request]+======+V1 API::++====-[.tab-label]*V1 API*-*Input*[source,text]@@ -636,9 +630,9 @@ http://localhost:8983/solr/admin/collections?action=ADDREPLICAPROP&collection=te====-[example.tab-pane#v2addreplicaprop]+V2 API::++====-[.tab-label]*V2 API**Input*[source,bash]@@ -650,7 +644,7 @@ curl -X PUT http://localhost:8983/api/collections/techproducts/shards/shard1/rep'----====---+========= ADDREPLICAPROP Parameters@@ -757,25 +751,22 @@ http://localhost:8983/solr/admin/collections?action=ADDREPLICAPROP&shard=shard1&Deletes an arbitrary property from a particular replica.-[.dynamic-tabs]-----[example.tab-pane#v1deletereplicaprop]+[tabs#deletereplicaprop-request]+======+V1 API::++====-[.tab-label]*V1 API*-*Input*[source,text]----http://localhost:8983/solr/admin/collections?action=DELETEREPLICAPROP&collection=techproducts&shard=shard1&replica=core_node2&property=preferredLeader-----====-[example.tab-pane#v2deletereplicaprop]+V2 API::++====-[.tab-label]*V2 API**Input*[source,bash]@@ -783,7 +774,7 @@ http://localhost:8983/solr/admin/collections?action=DELETEREPLICAPROP&collectioncurl -X DELETE http://localhost:8983/api/collections/techproducts/shards/shard1/replicas/core_node2/properties/preferredLeader----====---+========= DELETEREPLICAPROP Parametersdiff --git a/solr/solr-ref-guide/modules/deployment-guide/pages/shard-management.adoc b/solr/solr-ref-guide/modules/deployment-guide/pages/shard-management.adocindex 24d24ef8de4..54f04351c85 100644--- a/solr/solr-ref-guide/modules/deployment-guide/pages/shard-management.adoc+++ b/solr/solr-ref-guide/modules/deployment-guide/pages/shard-management.adoc@@ -1,4 +1,5 @@= Shard Management Commands+:tabs-sync-option::toclevels: 1// Licensed to the Apache Software Foundation (ASF) under one// or more contributor license agreements. See the NOTICE file@@ -32,13 +33,11 @@ bin/solr start -c -e techproducts[[splitshard]]== SPLITSHARD: Split a Shard-[.dynamic-tabs]-----[example.tab-pane#v1splitshard]+[tabs#splitshard-request]+======+V1 API::++====-[.tab-label]*V1 API*-*Input*[source,text]@@ -59,9 +58,9 @@ http://localhost:8983/solr/admin/collections?action=SPLITSHARD&collection=techpr----====-[example.tab-pane#v2splitshard]+V2 API::++====-[.tab-label]*V2 API**Input*[source,bash]@@ -74,6 +73,7 @@ curl -X POST http://localhost:8983/api/collections/techproducts/shards -H 'Conte}'----+*Output*[source,json]@@ -86,7 +86,7 @@ curl -X POST http://localhost:8983/api/collections/techproducts/shards -H 'Conte}----====---+======Splitting a shard will take an existing shard and break it into two pieces which are written to disk as two (new) shards.The original shard will continue to contain the same data as-is but it will start re-routing requests to the new shards.@@ -288,13 +288,11 @@ A new shard with a name can be created for an existing 'implicit' collection.Use SPLITSHARD for collections created with the 'compositeId' router (`router.key=compositeId`).-[.dynamic-tabs]-----[example.tab-pane#v1createshard]+[tabs#createshard-request]+======+V1 API::++====-[.tab-label]*V1 API*-*Input*[source,text]@@ -315,9 +313,9 @@ http://localhost:8983/solr/admin/collections?action=CREATESHARD&shard=newShardNa----====-[example.tab-pane#v2createshard]+V2 API::++====-[.tab-label]*V2 API**Input*[source,bash]@@ -328,6 +326,7 @@ curl -X POST http://localhost:8983/api/collections/techproducts/shards -H 'Conte}'----+*Output*[source,json]@@ -340,7 +339,7 @@ curl -X POST http://localhost:8983/api/collections/techproducts/shards -H 'Conte}----====---+======The default values for `replicationFactor` or `nrtReplicas`, `tlogReplicas`, `pullReplicas` from the collection is used to determine the number of replicas to be created for the new shard.This can be customized by explicitly passing the corresponding parameters to the request.@@ -452,29 +451,26 @@ Deleting a shard will unload all replicas of the shard, remove them from the colIt will only remove shards that are inactive, or which have no range given for custom sharding.-[.dynamic-tabs]----[example.tab-pane#v1deleteshard]+[tabs#deleteshard-request]+======+V1 API::++====-[.tab-label]*V1 API*-[source,bash]----http://localhost:8983/solr/admin/collections?action=DELETESHARD&shard=shard1&collection=techproducts----====-[example.tab-pane#v2deleteshard]+V2 API::++====-[.tab-label]*V2 API*--[source,bash]----curl -X DELETE http://localhost:8983/api/collections/techproducts/shards/shard1----====---+========= DELETESHARD Parameters@@ -557,13 +553,11 @@ If the status is anything other than "success", an error message will explain whIn the unlikely event of a shard losing its leader, this command can be invoked to force the election of a new leader.-[.dynamic-tabs]-----[example.tab-pane#v1forceleader]+[tabs#forceleader-request]+======+V1 API::++====-[.tab-label]*V1 API*-*Input*[source,text]@@ -584,15 +578,16 @@ http://localhost:8983/solr/admin/collections?action=FORCELEADER&collection=techp----====-[example.tab-pane#v2forceleader]+V2 API::++====-[.tab-label]*V2 API**Input*[source,bash]----curl -X POST http://localhost:8983/api/collections/techproducts/shards/shard1/force-leader----+*Output*[source,json]@@ -605,7 +600,7 @@ curl -X POST http://localhost:8983/api/collections/techproducts/shards/shard1/fo}----====---+========= FORCELEADER Parameters@@ -649,13 +644,11 @@ The specified `location` must contain all files that make up a core's `data/indeUsers are responsible for ensuring that the index installed to a shard is compatible with the schema and configuration for the collection hosting that shard.-[.dynamic-tabs]-----[example.tab-pane#v1installshard]+[tabs#installshard-request]+======+V1 API::++====-[.tab-label]*V1 API*-*Input*[source,text]@@ -676,9 +669,9 @@ http://localhost:8983/solr/admin/collections?action=INSTALLSHARDDATA&collection=----====-[example.tab-pane#v2installshard]+V2 API::++====-[.tab-label]*V2 API**Input*[source,bash]@@ -690,6 +683,7 @@ curl -X POST http://localhost:8983/api/collections/techproducts/shards/shard1/in}'----+*Output*[source,json]@@ -702,7 +696,7 @@ curl -X POST http://localhost:8983/api/collections/techproducts/shards/shard1/in}----====---+========= INSTALLSHARDDATA Parametersdiff --git a/solr/solr-ref-guide/modules/deployment-guide/pages/task-management.adoc b/solr/solr-ref-guide/modules/deployment-guide/pages/task-management.adocindex 7995d99f318..a320d9cfdf3 100644--- a/solr/solr-ref-guide/modules/deployment-guide/pages/task-management.adoc+++ b/solr/solr-ref-guide/modules/deployment-guide/pages/task-management.adoc@@ -1,4 +1,5 @@= Task Management+:tabs-sync-option:// Licensed to the Apache Software Foundation (ASF) under one// or more contributor license agreements. See the NOTICE file// distributed with this work for additional information@@ -40,28 +41,26 @@ Task management interface supports the following types of operations:== Listing All Active Cancellable TasksTo list all the active cancellable tasks currently running, please use the following syntax:-[.dynamic-tabs]----[example.tab-pane#v1listalltasks]+[tabs#listalltasks]+======+V1 API::++====-[.tab-label]*V1 API*-[source,bash]----curl -X GET "http://localhost:8983/solr/collectionName/tasks/list"----====-[example.tab-pane#v2listalltasks]+V2 API::++====-[.tab-label]*V2 API*-[source,bash]----curl -X GET "http://localhost:8983/v2/collections/collectionName/tasks/list"----====---+========= Sample Response@@ -79,28 +78,25 @@ curl -X GET "http://localhost:8983/v2/collections/collectionName/tasks/list"== Cancelling An Active Cancellable TaskTo cancel an active task, please use the following syntax:-[.dynamic-tabs]----[example.tab-pane#v1cancelalltasks]+[tabs#cancelalltasks]+======+V1 API::++====-[.tab-label]*V1 API*-[source,bash]----curl -X GET "http://localhost:8983/solr/collectionName/tasks/cancel?queryUUID=5"----====--[example.tab-pane#v2cancelalltasks]+V2 API::++====-[.tab-label]*V2 API*-[source,bash]----curl -X GET "http://localhost:8983/v2/collections/collectionName/tasks/cancel?queryUUID=5"----====---+========= Sample Response==== If the task UUID was found and successfully cancelled:@@ -128,28 +124,26 @@ curl -X GET "http://localhost:8983/v2/collections/collectionName/tasks/cancel?qu== Check Status of a Specific TaskTo check the status of a specific task, please use the following syntax:-[.dynamic-tabs]----[example.tab-pane#v1checksingletask]+[tabs#checksingletask]+======+V1 API::++====-[.tab-label]*V1 API*-[source,bash]----curl -X GET "http://localhost:8983/solr/collectionName/tasks/list?taskUUID=5"----====-[example.tab-pane#v2checksingletask]+V2 API::++====-[.tab-label]*V2 API*-[source,bash]----curl -X GET "http://localhost:8983/v2/collections/collectionName/tasks/list?taskUUID=5"----====---+========= taskUUID Parameter`taskUUID` parameter can be used to specify a task UUID whose status can be checked.diff --git a/solr/solr-ref-guide/modules/deployment-guide/pages/zookeeper-access-control.adoc b/solr/solr-ref-guide/modules/deployment-guide/pages/zookeeper-access-control.adocindex 19c85d67989..c976feb96a3 100644--- a/solr/solr-ref-guide/modules/deployment-guide/pages/zookeeper-access-control.adoc+++ b/solr/solr-ref-guide/modules/deployment-guide/pages/zookeeper-access-control.adoc@@ -1,4 +1,5 @@= ZooKeeper Access Control+:tabs-sync-option:// Licensed to the Apache Software Foundation (ASF) under one// or more contributor license agreements. See the NOTICE file// distributed with this work for additional information@@ -252,12 +253,11 @@ Below examples are for `digest` scheme.* ZK credentials are passed through System Properties via `DzkDigestUsername`, `DzkDigestPassword`, `DzkDigestReadonlyUsername`and `DzkDigestReadonlyPassword` properties names.-[.dynamic-tabs]----[example.tab-pane#system-props-nix]+[tabs#system-props]+======+*nix::++====-[.tab-label]**nix*-.solr.in.sh[source,bash]----@@ -272,10 +272,9 @@ SOLR_OPTS="$SOLR_OPTS $SOLR_ZK_CREDS_AND_ACLS"----====-[example.tab-pane#system-props-windows]+Windows::++====-[.tab-label]*Windows*-.solr.in.cmd[source,powershell]----@@ -288,9 +287,7 @@ set SOLR_ZK_CREDS_AND_ACLS=-DzkACLProvider=org.apache.solr.common.cloud.DigestZkset SOLR_OPTS=%SOLR_OPTS% %SOLR_ZK_CREDS_AND_ACLS%----====-----+========== Through a File@@ -304,13 +301,11 @@ zkDigestReadonlyPassword=CHANGEME-READONLY-PASSWORD* Pass the file path via System Properties:--[.dynamic-tabs]----[example.tab-pane#file-system-props-nix]+[tabs#file-sytem-props]+======+*nix::++====-[.tab-label]**nix*-.solr.in.sh[source,bash]----@@ -325,10 +320,9 @@ SOLR_OPTS="$SOLR_OPTS $SOLR_ZK_CREDS_AND_ACLS"----====-[example.tab-pane#file-system-props-windows]+Windows::++====-[.tab-label]*Windows*-.solr.in.cmd[source,powershell]----@@ -340,25 +334,19 @@ set SOLR_ZK_CREDS_AND_ACLS=-DzkACLProvider=org.apache.solr.common.cloud.DigestZkset SOLR_OPTS=%SOLR_OPTS% %SOLR_ZK_CREDS_AND_ACLS%----====-----+========== Through a Custom Credentials Injector-* Alternatively, you can create your own credentials injector byimplementing {solr-javadocs}/solrj-zookeeper/org/apache/solr/common/cloud/ZkCredentialsInjector.html[`ZkCredentialsInjector`] and passit through system props using DzkCredentialsInjector variable name.---[.dynamic-tabs]----[example.tab-pane#custom-injector-nix]+[tabs#custom-injector]+======+*nix::++====-[.tab-label]**nix*-.solr.in.sh[source,bash]----@@ -370,11 +358,9 @@ SOLR_ZK_CREDS_AND_ACLS="-DzkACLProvider=org.apache.solr.common.cloud.DigestZkACLSOLR_OPTS="$SOLR_OPTS $SOLR_ZK_CREDS_AND_ACLS"----====--[example.tab-pane#-custom-injector-windows]+Windows::++====-[.tab-label]*Windows*-.solr.in.cmd[source,powershell]----@@ -385,9 +371,7 @@ set SOLR_ZK_CREDS_AND_ACLS=-DzkACLProvider=org.apache.solr.common.cloud.DigestZkset SOLR_OPTS=%SOLR_OPTS% %SOLR_ZK_CREDS_AND_ACLS%----====-----+========= ZooKeeper ACLs in Solr CLI@@ -398,12 +382,11 @@ These Solr scripts can enable use of ZooKeeper ACLs by setting the appropriate sUncomment the following and replace the passwords with ones you choose to enable the parameters and ACL credentials providersin the following files:-[.dynamic-tabs]----[example.tab-pane#nix]+[tabs]+======+*nix::++====-[.tab-label]**nix*-.solr.in.sh[source,bash]----@@ -417,10 +400,9 @@ in the following files:----====-[example.tab-pane#windows]+Windows::++====-[.tab-label]*Windows*-.solr.in.cmd[source,powershell]----@@ -433,7 +415,7 @@ REM -DzkDigestReadonlyUsername=readonly-user -DzkDigestReadonlyPassword=CHANGEMREM set SOLR_OPTS=%SOLR_OPTS% %SOLR_ZK_CREDS_AND_ACLS%----====---+======== Changing ACL Schemes@@ -445,26 +427,26 @@ First uncomment the `SOLR_ZK_CREDS_AND_ACLS` environment variable definition inThen run the command below appropriate for your operating system:-[.dynamic-tabs]----[example.tab-pane#updateacls-unix]+[tabs#updateacls]+======+*nix::++====-[.tab-label]**nix*[source,bash]----$ bin/solr zk updateacls /zk-path----====-[example.tab-pane#updateacls-windows]+Windows::++====-[.tab-label]*Windows*[source,powershell]----$ bin/solr.cmd zk updateacls /zk-path----====---+======Changing ACLs in ZooKeeper should only be done while your SolrCloud cluster is stopped.Attempting to do so while Solr is running may result in inconsistent state and some nodes becoming inaccessible.diff --git a/solr/solr-ref-guide/modules/deployment-guide/pages/zookeeper-ensemble.adoc b/solr/solr-ref-guide/modules/deployment-guide/pages/zookeeper-ensemble.adocindex 9a899ca36c1..995ca6314b9 100644--- a/solr/solr-ref-guide/modules/deployment-guide/pages/zookeeper-ensemble.adoc+++ b/solr/solr-ref-guide/modules/deployment-guide/pages/zookeeper-ensemble.adoc@@ -1,4 +1,5 @@= ZooKeeper Ensemble Configuration+:tabs-sync-option:// Licensed to the Apache Software Foundation (ASF) under one// or more contributor license agreements. See the NOTICE file// distributed with this work for additional information@@ -412,12 +413,12 @@ ZK_CREATE_CHROOT=true bin/solr start -e cloud -z zk1:2181,zk2:2181,zk3:2181/solrIf you update Solr include files (`solr.in.sh` or `solr.in.cmd`), which overrides defaults used with `bin/solr`, you will not have to use the `-z` parameter with `bin/solr` commands.-[.dynamic-tabs]----[example.tab-pane#linux1]+[tabs]+======+Linux::++====-[.tab-label]*Linux: solr.in.sh*-+.solr.in.shThe section to look for will be commented out:[source,properties]@@ -439,10 +440,10 @@ ZK_HOST="zk1:2181,zk2:2181,zk3:2181/solr"----====-[example.tab-pane#zkwindows]+Windows::++====-[.tab-label]*Windows: solr.in.cmd*-+.solr.in.cmdThe section to look for will be commented out:[source,bat]@@ -463,7 +464,7 @@ REM Leave empty if not using SolrCloudset ZK_HOST=zk1:2181,zk2:2181,zk3:2181/solr----====---+======Now you will not have to enter the connection string when starting Solr.@@ -502,12 +503,12 @@ When you use Solr's bundled ZooKeeper server instead of setting up an external ZAdd the setting to the `SOLR_OPTS` environment variable in Solr's include file (`bin/solr.in.sh` or `solr.in.cmd`):-[.dynamic-tabs]----[example.tab-pane#linux2]+[tabs]+======+Linux::++====-[.tab-label]*Linux: solr.in.sh*-+.solr.in.shThe section to look for will start:[source,properties]@@ -523,10 +524,10 @@ Add the following line to increase the file size limit to 2MB:SOLR_OPTS="$SOLR_OPTS -Djute.maxbuffer=0x200000"====-[example.tab-pane#zkwindows2]+Windows::++====-[.tab-label]*Windows: solr.in.cmd*-+.solr.in.cmdThe section to look for will start:[source,bat]@@ -543,7 +544,7 @@ Add the following line to increase the file size limit to 2MB:set SOLR_OPTS=%SOLR_OPTS% -Djute.maxbuffer=0x200000----====---+======== Securing the ZooKeeper Connectiondiff --git a/solr/solr-ref-guide/modules/getting-started/pages/tutorial-films.adoc b/solr/solr-ref-guide/modules/getting-started/pages/tutorial-films.adocindex 2af0776532f..269610912a8 100644--- a/solr/solr-ref-guide/modules/getting-started/pages/tutorial-films.adoc+++ b/solr/solr-ref-guide/modules/getting-started/pages/tutorial-films.adoc@@ -1,5 +1,6 @@= Exercise 2: Index Films Data:experimental:+:tabs-sync-option:// Licensed to the Apache Software Foundation (ASF) under one// or more contributor license agreements. See the NOTICE file// distributed with this work for additional information@@ -219,12 +220,11 @@ It comes in three formats: JSON, XML and CSV.Pick one of the formats and index it into the "films" collection (in each example, one command is for Unix/MacOS and the other is for Windows):.To Index JSON Format-[.dynamic-tabs]----[example.tab-pane#unixindexjson]+[tabs#index-json]+======+Linux/Mac::++====-[.tab-label]*Linux/Mac*-[,console]----$ bin/solr post -c films example/films/films.json@@ -232,25 +232,23 @@ $ bin/solr post -c films example/films/films.json----====-[example.tab-pane#winindexjson]+Windows::++====-[.tab-label]*Windows*-[,console]----$ bin/solr post -c films example\films\films.json----====---+======.To Index XML Format-[.dynamic-tabs]----[example.tab-pane#unixindexxml]+[tabs#index-xml]+======+Linux/Mac::++====-[.tab-label]*Linux/Mac*-[,console]----$ bin/solr post -c films example/films/films.xml@@ -258,25 +256,23 @@ $ bin/solr post -c films example/films/films.xml----====-[example.tab-pane#winindexxml]+Windows::++====-[.tab-label]*Windows*-[,console]----$ bin/solr post -c films example\films\films.xml----====---+======.To Index CSV Format-[.dynamic-tabs]----[example.tab-pane#unixindexcsv]+[tabs#index-csv]+======+Linux/Mac::++====-[.tab-label]*Linux/Mac*-[,console]----$ bin/solr post -c films example/films/films.csv -params "f.genre.split=true&f.directed_by.split=true&f.genre.separator=|&f.directed_by.separator=|"@@ -284,16 +280,15 @@ $ bin/solr post -c films example/films/films.csv -params "f.genre.split=true&f.d----====-[example.tab-pane#winindexcsv]+Windows::++====-[.tab-label]*Windows*-[,console]----$ bin/solr post -c films example\films\films.csv -params "f.genre.split=true&f.directed_by.split=true&f.genre.separator=|&f.directed_by.separator=|"----====---+======Each command includes these main parameters:diff --git a/solr/solr-ref-guide/modules/getting-started/pages/tutorial-paramsets.adoc b/solr/solr-ref-guide/modules/getting-started/pages/tutorial-paramsets.adocindex a6d083660c9..a0a58bfe450 100644--- a/solr/solr-ref-guide/modules/getting-started/pages/tutorial-paramsets.adoc+++ b/solr/solr-ref-guide/modules/getting-started/pages/tutorial-paramsets.adoc@@ -1,5 +1,6 @@= Exercise 4: Using ParamSets:experimental:+:tabs-sync-option:// Licensed to the Apache Software Foundation (ASF) under one// or more contributor license agreements. See the NOTICE file// distributed with this work for additional information@@ -68,29 +69,26 @@ and for the release date also to be single valued.Now that we have updated our Schema, we need to index the sample film data, or, if you already have indexed it, then re-index it to take advantage of the new field definitions we added.-[.dynamic-tabs]----[example.tab-pane#unixindexjson]+[tabs#index-json]+======+Linux/Mac::++====-[.tab-label]*Linux/Mac*-[,console]----$ bin/solr post -c films example/films/films.json-----====-[example.tab-pane#winindexjson]+Windows::++====-[.tab-label]*Windows*-[,console]----$ bin/solr post -c films example\films\films.json----====---+========= Let's get Searching!diff --git a/solr/solr-ref-guide/modules/getting-started/pages/tutorial-solrcloud.adoc b/solr/solr-ref-guide/modules/getting-started/pages/tutorial-solrcloud.adocindex 03de6b396c3..f13380de719 100644--- a/solr/solr-ref-guide/modules/getting-started/pages/tutorial-solrcloud.adoc+++ b/solr/solr-ref-guide/modules/getting-started/pages/tutorial-solrcloud.adoc@@ -1,4 +1,5 @@= Getting Started with SolrCloud+:tabs-sync-option:// Licensed to the Apache Software Foundation (ASF) under one// or more contributor license agreements. See the NOTICE file// distributed with this work for additional information@@ -109,26 +110,26 @@ The `_default` configuration is useful when you're still designing a schema forHowever, after creating your collection, the schemaless functionality can be disabled in order to lock down the schema (so that documents indexed after doing so will not alter the schema) or to configure the schema by yourself.This can be done as follows (assuming your collection name is `mycollection`):-[.dynamic-tabs]----[example.tab-pane#v1autocreatefalse]+[tabs#autocreatefalse]+======+V1 API::++====-[.tab-label]*V1 API*[,console]----$ curl http://host:8983/solr/mycollection/config -d '{"set-user-property": {"update.autoCreateFields":"false"}}'----====-[example.tab-pane#v2autocreatefalse]+V2 API SolrCloud::++====-[.tab-label]*V2 API SolrCloud*[,console]----$ curl http://host:8983/api/collections/mycollection/config -d '{"set-user-property": {"update.autoCreateFields":"false"}}'----====---+======At this point, you should have a new collection created in your local SolrCloud cluster.To verify this, you can run the status command:diff --git a/solr/solr-ref-guide/modules/getting-started/pages/tutorial-vectors.adoc b/solr/solr-ref-guide/modules/getting-started/pages/tutorial-vectors.adocindex 63cffc16542..90c84dc5345 100644--- a/solr/solr-ref-guide/modules/getting-started/pages/tutorial-vectors.adoc+++ b/solr/solr-ref-guide/modules/getting-started/pages/tutorial-vectors.adoc@@ -1,5 +1,6 @@= Exercise 5: Using Vectors:experimental:+:tabs-sync-option:// Licensed to the Apache Software Foundation (ASF) under one// or more contributor license agreements. See the NOTICE file// distributed with this work for additional information@@ -74,12 +75,11 @@ $ curl http://localhost:8983/solr/films/schema -X POST -H 'Content-type:applicatWe have the vectors embedded in our `films.json` file, so let's index that data, taking advantage of our new schema field we just defined.-[.dynamic-tabs]----[example.tab-pane#unixindexjson]+[tabs#index-json]+======+Linux/Mac::++====-[.tab-label]*Linux/Mac*-[,console]----$ bin/solr post -c films example/films/films.json@@ -87,16 +87,15 @@ $ bin/solr post -c films example/films/films.json----====-[example.tab-pane#winindexjson]+Windows::++====-[.tab-label]*Windows*-[,console]----$ bin/solr post -c films example\films\films.json----====---+========= Let's do some Vector searchesBefore making the queries, we define an example target vector, simulating a person thatdiff --git a/solr/solr-ref-guide/modules/indexing-guide/pages/analyzers.adoc b/solr/solr-ref-guide/modules/indexing-guide/pages/analyzers.adocindex 876f15dc367..1f15d9d37aa 100644--- a/solr/solr-ref-guide/modules/indexing-guide/pages/analyzers.adoc+++ b/solr/solr-ref-guide/modules/indexing-guide/pages/analyzers.adoc@@ -1,4 +1,5 @@= Analyzers+:tabs-sync-option:// Licensed to the Apache Software Foundation (ASF) under one// or more contributor license agreements. See the NOTICE file// distributed with this work for additional information@@ -42,11 +43,11 @@ Setting up an analyzer chain is very straightforward; you specify a simple `<anaFor example:-[.dynamic-tabs]----[example.tab-pane#byname]+[tabs#analyzer]+======+With name::++====-[.tab-label]*With name*[source,xml]----<fieldType name="nametext" class="solr.TextField">@@ -61,9 +62,10 @@ For example:Tokenizer and filter factory classes are referred by their symbolic names (SPI names).Here, name="standard" refers `org.apache.lucene.analysis.standard.StandardTokenizerFactory`.====-[example.tab-pane#byclass]++With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<fieldType name="nametext" class="solr.TextField">@@ -77,7 +79,7 @@ Here, name="standard" refers `org.apache.lucene.analysis.standard.StandardTokeni----Note that classes in the `org.apache.lucene.analysis` package may be referred to here with the shorthand `solr.` prefix.====---+======In this case, no Analyzer class was specified on the `<analyzer>` element.Rather, a sequence of more specialized classes are wired together and collectively act as the Analyzer for the field.@@ -104,11 +106,11 @@ If you provide a simple `<analyzer>` definition for a field type, as in the examIf you want distinct analyzers for each phase, you may include two `<analyzer>` definitions distinguished with a type attribute.For example:-[.dynamic-tabs]----[example.tab-pane#byname-phases]+[tabs#analyzer-phases]+======+With name::++====-[.tab-label]*With name*[source,xml]----<fieldType name="nametext" class="solr.TextField">@@ -125,9 +127,10 @@ For example:</fieldType>----====-[example.tab-pane#byclass-phases]++With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<fieldType name="nametext" class="solr.TextField">@@ -144,7 +147,7 @@ For example:</fieldType>----====---+======In this theoretical example, at index time the text is tokenized, the tokens are set to lowercase, any that are not listed in `keepwords.txt` are discarded and those that remain are mapped to alternate values as defined by the synonym rules in the file `syns.txt`.This essentially builds an index from a restricted set of possible values and then normalizes them to values that may not even occur in the original text.diff --git a/solr/solr-ref-guide/modules/indexing-guide/pages/charfilters.adoc b/solr/solr-ref-guide/modules/indexing-guide/pages/charfilters.adocindex abcf27c537d..cdce3ee77cd 100644--- a/solr/solr-ref-guide/modules/indexing-guide/pages/charfilters.adoc+++ b/solr/solr-ref-guide/modules/indexing-guide/pages/charfilters.adoc@@ -1,4 +1,5 @@= CharFilters+:tabs-sync-option:// Licensed to the Apache Software Foundation (ASF) under one// or more contributor license agreements. See the NOTICE file// distributed with this work for additional information@@ -29,11 +30,11 @@ This filter requires specifying a `mapping` argument, which is the path and nameExample:-[.dynamic-tabs]----[example.tab-pane#byname-charfilter]+[tabs#charfilter]+======+With name::++====-[.tab-label]*With name*[source,xml]----<analyzer>@@ -43,9 +44,10 @@ Example:</analyzer>----====-[example.tab-pane#byclass-charfilter]++With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<analyzer>@@ -55,7 +57,7 @@ Example:</analyzer>----====---+======Mapping file syntax:@@ -122,11 +124,11 @@ The table below presents examples of HTML stripping.Example:-[.dynamic-tabs]----[example.tab-pane#byname-charfilter-htmlstrip]+[tabs#charfilter-htmlstrip]+======+With name::++====-[.tab-label]*With name*[source,xml]----<analyzer>@@ -136,9 +138,10 @@ Example:</analyzer>----====-[example.tab-pane#byclass-charfilter-htmlstrip]++With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<analyzer>@@ -148,7 +151,7 @@ Example:</analyzer>----====---+======== solr.ICUNormalizer2CharFilterFactory@@ -189,11 +192,11 @@ Default is `[]`, as a null set, no filtering (all codepoints are subject to normExample:-[.dynamic-tabs]----[example.tab-pane#byname-charfilter-icunormalizer2]+[tabs#charfilter-icunormalizer2]+======+With name::++====-[.tab-label]*With name*[source,xml]----<analyzer>@@ -203,9 +206,10 @@ Example:</analyzer>----====-[example.tab-pane#byclass-charfilter-icunormalizer2]++With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<analyzer>@@ -215,7 +219,7 @@ Example:</analyzer>----====---+======== solr.PatternReplaceCharFilterFactory@@ -243,11 +247,11 @@ The text to use to replace matching patterns.You can configure this filter in the schema like this:-[.dynamic-tabs]----[example.tab-pane#byname-charfilter-patternreplace]+[tabs#charfilter-patternreplace]+======+With name::++====-[.tab-label]*With name*[source,xml]----<analyzer>@@ -258,9 +262,10 @@ You can configure this filter in the schema like this:</analyzer>----====-[example.tab-pane#byclass-charfilter-patternreplace]++With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<analyzer>@@ -271,7 +276,7 @@ You can configure this filter in the schema like this:</analyzer>----====---+======The table below presents examples of regex-based pattern replacement:diff --git a/solr/solr-ref-guide/modules/indexing-guide/pages/filters.adoc b/solr/solr-ref-guide/modules/indexing-guide/pages/filters.adocindex fa2c3365a56..ba90cb3c725 100644--- a/solr/solr-ref-guide/modules/indexing-guide/pages/filters.adoc+++ b/solr/solr-ref-guide/modules/indexing-guide/pages/filters.adoc@@ -1,4 +1,5 @@= Filters+:tabs-sync-option:// Licensed to the Apache Software Foundation (ASF) under one// or more contributor license agreements. See the NOTICE file// distributed with this work for additional information@@ -38,11 +39,11 @@ Filters are configured with a `<filter>` element in the schema file as a child oFor example:-[.dynamic-tabs]----[example.tab-pane#byname-filterexample]+[tabs#filter-example]+======+With name::++====-[.tab-label]*With name*[source,xml]----<fieldType name="text" class="solr.TextField">@@ -54,9 +55,10 @@ For example:</fieldType>----====-[example.tab-pane#byclass-filterexample]++With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<fieldType name="text" class="solr.TextField">@@ -68,7 +70,7 @@ For example:</fieldType>----====---+======This example starts with Solr's standard tokenizer, which breaks the field's text into tokens.All the tokens are then set to lowercase, which will facilitate case-insensitive matching at query time.@@ -97,11 +99,11 @@ These stemmers are described in xref:language-analysis.adoc[].Arguments may be passed to tokenizer factories to modify their behavior by setting attributes on the `<filter>` element.For example:-[.dynamic-tabs]----[example.tab-pane#byname-filter2]+[tabs#filter2]+======+With name::++====-[.tab-label]*With name*[source,xml]----<fieldType name="semicolonDelimited" class="solr.TextField">@@ -112,9 +114,10 @@ For example:</fieldType>----====-[example.tab-pane#byclass-filter-2]++With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<fieldType name="semicolonDelimited" class="solr.TextField">@@ -125,7 +128,7 @@ For example:</fieldType>----====---+======The following sections describe the filter factories that are included in this release of Solr.@@ -166,11 +169,11 @@ If `true`, the original token is preserved: "thé" -> "the", "thé"*Example:*-[.dynamic-tabs]----[example.tab-pane#byname-filter-asciifolding]+[tabs#filter-asciifolding]+======+With name::++====-[.tab-label]*With name*[source,xml]----<analyzer>@@ -179,9 +182,10 @@ If `true`, the original token is preserved: "thé" -> "the", "thé"</analyzer>----====-[example.tab-pane#byclass-filter-asciifolding]++With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<analyzer>@@ -190,7 +194,7 @@ If `true`, the original token is preserved: "thé" -> "the", "thé"</analyzer>----====---+======*In:* "á" (Unicode character 00E1)@@ -254,11 +258,11 @@ The value `auto` will allow the filter to identify the language, or a comma-sepa*Example:*-[.dynamic-tabs]----[example.tab-pane#byname-filter-beidermorse]+[tabs#filter-beidermorse]+======+With name::++====-[.tab-label]*With name*[source,xml]----<analyzer>@@ -267,9 +271,10 @@ The value `auto` will allow the filter to identify the language, or a comma-sepa</analyzer>----====-[example.tab-pane#byclass-filter-beidermorse]++With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<analyzer>@@ -278,7 +283,7 @@ The value `auto` will allow the filter to identify the language, or a comma-sepa</analyzer>----====---+======== Classic Filter@@ -290,11 +295,11 @@ This filter takes the output of the xref:tokenizers.adoc#classic-tokenizer[Class*Example:*-[.dynamic-tabs]----[example.tab-pane#byname-filter-classic]+[tabs#filter-classic]+======+With name::++====-[.tab-label]*With name*[source,xml]----<analyzer>@@ -303,9 +308,10 @@ This filter takes the output of the xref:tokenizers.adoc#classic-tokenizer[Class</analyzer>----====-[example.tab-pane#byclass-filter-classic]++With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<analyzer>@@ -314,7 +320,7 @@ This filter takes the output of the xref:tokenizers.adoc#classic-tokenizer[Class</analyzer>----====---+======*In:* "I.B.M. cat's can't"@@ -363,11 +369,11 @@ If `true`, the filter ignores the case of words when comparing them to the commo*Example:*-[.dynamic-tabs]----[example.tab-pane#byname-filter-commongrams]+[tabs#filter-commongrams]+======+With name::++====-[.tab-label]*With name*[source,xml]----<analyzer type="index">@@ -380,9 +386,10 @@ If `true`, the filter ignores the case of words when comparing them to the commo</analyzer>----====-[example.tab-pane#byclass-filter-commongrams]++With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<analyzer type="index">@@ -395,7 +402,7 @@ If `true`, the filter ignores the case of words when comparing them to the commo</analyzer>----====---+======*In:* "the cat in the hat"@@ -437,11 +444,11 @@ Setting this to `false` will enable phonetic matching, but the exact spelling of*Example:*-[.dynamic-tabs]----[example.tab-pane#byname-filter-daitchmokotoffsondex]+[tabs#filter-daitchmokotoffsondex]+======+With name::++====-[.tab-label]*With name*[source,xml]----<analyzer>@@ -450,9 +457,10 @@ Setting this to `false` will enable phonetic matching, but the exact spelling of</analyzer>----====-[example.tab-pane#byclass-filter-daitchmokotoffsondex]++With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<analyzer>@@ -461,7 +469,7 @@ Setting this to `false` will enable phonetic matching, but the exact spelling of</analyzer>----====---+======== Double Metaphone Filter@@ -496,11 +504,11 @@ The maximum length of the code to be generated.Default behavior for inject (`true`): keep the original token and add phonetic token(s) at the same position.-[.dynamic-tabs]----[example.tab-pane#byname-filter-doublemetaphone]+[tabs#filter-doublemetaphone]+======+With name::++====-[.tab-label]*With name*[source,xml]----<analyzer>@@ -509,9 +517,10 @@ Default behavior for inject (`true`): keep the original token and add phonetic t</analyzer>----====-[example.tab-pane#byclass-filter-doublemetaphone]++With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<analyzer>@@ -520,7 +529,7 @@ Default behavior for inject (`true`): keep the original token and add phonetic t</analyzer>----====---+======*In:* "four score and Kuczewski"@@ -570,11 +579,11 @@ The character used to separate the token and the boost.*Example:*-[.dynamic-tabs]----[example.tab-pane#byname-filter-delimitedBoost]+[tabs#filter-delimitedBoost]+======+With name::++====-[.tab-label]*With name*[source,xml]----<analyzer>@@ -583,9 +592,10 @@ The character used to separate the token and the boost.</analyzer>----====-[example.tab-pane#byclass-filter-delimitedBoost]++With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<analyzer>@@ -594,7 +604,7 @@ The character used to separate the token and the boost.</analyzer>----====---+======*In:* "leopard|0.5 panthera uncia|0.9"@@ -661,11 +671,11 @@ If `true` keep the original term even if it is shorter than `minGramSize` or lonDefault behavior.-[.dynamic-tabs]----[example.tab-pane#byname-filter-edgengram]+[tabs#filter-edgengram]+======+With name::++====-[.tab-label]*With name*[source,xml]----<analyzer>@@ -674,9 +684,10 @@ Default behavior.</analyzer>----====-[example.tab-pane#byclass-filter-edgengram]++With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<analyzer>@@ -685,7 +696,7 @@ Default behavior.</analyzer>----====---+======*In:* "four score and twenty"@@ -757,11 +768,11 @@ This filter stems plural English words to their singular form.*Example:*-[.dynamic-tabs]----[example.tab-pane#byname-filter-englishminimalstem]+[tabs#filter-englishminimalstem]+======+With name::++====-[.tab-label]*With name*[source,xml]----<analyzer type="index">@@ -770,9 +781,10 @@ This filter stems plural English words to their singular form.</analyzer>----====-[example.tab-pane#byclass-filter-englishminimalstem]++With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<analyzer type="index">@@ -781,7 +793,7 @@ This filter stems plural English words to their singular form.</analyzer>----====---+======*In:* "dogs cats"@@ -800,11 +812,11 @@ Note that plural possessives, e.g., the *s'* in "divers' snorkels", are not remo*Example:*-[.dynamic-tabs]----[example.tab-pane#byname-filter-englishpossessive]+[tabs#filter-englishphossessive]+======+With name::++====-[.tab-label]*With name*[source,xml]----<analyzer>@@ -813,9 +825,10 @@ Note that plural possessives, e.g., the *s'* in "divers' snorkels", are not remo</analyzer>----====-[example.tab-pane#byclass-filter-englishpossessive]++With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<analyzer>@@ -824,7 +837,7 @@ Note that plural possessives, e.g., the *s'* in "divers' snorkels", are not remo</analyzer>----====---+======*In:* "Man's dog bites dogs' man"@@ -862,11 +875,11 @@ If exceeded, no output token is emitted.*Example:*-[.dynamic-tabs]----[example.tab-pane#byname-filter-fingerprint]+[tabs#filter-fingerprint]+======+With name::++====-[.tab-label]*With name*[source,xml]----<analyzer type="index">@@ -875,9 +888,10 @@ If exceeded, no output token is emitted.</analyzer>----====-[example.tab-pane#byclass-filter-fingerprint]++With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<analyzer type="index">@@ -886,7 +900,7 @@ If exceeded, no output token is emitted.</analyzer>----====---+======*In:* "the quick brown fox jumped over the lazy dog"@@ -966,11 +980,11 @@ If `true`, an error while reading an affix rule causes a ParseException, otherwi*Example:*-[.dynamic-tabs]----[example.tab-pane#byname-filter-hunspellstem]+[tabs#filter-hunspellstem]+======+With name::++====-[.tab-label]*With name*[source,xml]----<analyzer type="index">@@ -983,9 +997,10 @@ If `true`, an error while reading an affix rule causes a ParseException, otherwi</analyzer>----====-[example.tab-pane#byclass-filter-hunspellstem]++With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<analyzer type="index">@@ -998,7 +1013,7 @@ If `true`, an error while reading an affix rule causes a ParseException, otherwi</analyzer>----====---+======*In:* "jump jumping jumped"@@ -1020,11 +1035,11 @@ This filter is generally only useful at index time.*Example:*-[.dynamic-tabs]----[example.tab-pane#byname-filter-hyphenatedwords]+[tabs#filter-hyphenatedwords]+======+With name::++====-[.tab-label]*With name*[source,xml]----<analyzer type="index">@@ -1033,9 +1048,9 @@ This filter is generally only useful at index time.</analyzer>----====-[example.tab-pane#byclass-filter-hyphenatedwords]+With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<analyzer type="index">@@ -1044,7 +1059,7 @@ This filter is generally only useful at index time.</analyzer>----====---+======*In:* "A hyphen- ated word"@@ -1075,11 +1090,11 @@ See the http://icu-project.org/apiref/icu4j/com/ibm/icu/text/UnicodeSet.html[Uni*Example without a filter:*-[.dynamic-tabs]----[example.tab-pane#byname-filter-icufolding]+[tabs#filter-icufolding]+======+With name::++====-[.tab-label]*With name*[source,xml]----<analyzer>@@ -1088,9 +1103,10 @@ See the http://icu-project.org/apiref/icu4j/com/ibm/icu/text/UnicodeSet.html[Uni</analyzer>----====-[example.tab-pane#byclass-filter-icufolding]++With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<analyzer>@@ -1099,7 +1115,7 @@ See the http://icu-project.org/apiref/icu4j/com/ibm/icu/text/UnicodeSet.html[Uni</analyzer>----====---+======*Example with a filter to exclude Swedish/Finnish characters:*@@ -1160,11 +1176,11 @@ See the http://icu-project.org/apiref/icu4j/com/ibm/icu/text/UnicodeSet.html[Uni*Example with NFKC_Casefold:*-[.dynamic-tabs]----[example.tab-pane#byname-filter-icunormalizer2]+[tabs#filter-icunormalizer2]+======+With name::++====-[.tab-label]*With name*[source,xml]----<analyzer>@@ -1173,9 +1189,10 @@ See the http://icu-project.org/apiref/icu4j/com/ibm/icu/text/UnicodeSet.html[Uni</analyzer>----====-[example.tab-pane#byclass-filter-icunormalizer2]++With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<analyzer>@@ -1184,7 +1201,7 @@ See the http://icu-project.org/apiref/icu4j/com/ibm/icu/text/UnicodeSet.html[Uni</analyzer>----====---+======*Example with a filter to exclude Swedish/Finnish characters:*@@ -1232,11 +1249,11 @@ The direction of the ICU transform. Valid options are `forward` and `reverse`.*Example:*-[.dynamic-tabs]----[example.tab-pane#byname-filter-icutransform]+[tabs#filter-icutransform]+======+With name::++====-[.tab-label]*With name*[source,xml]----<analyzer>@@ -1245,9 +1262,10 @@ The direction of the ICU transform. Valid options are `forward` and `reverse`.</analyzer>----====-[example.tab-pane#byclass-filter-icutransform]++With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<analyzer>@@ -1256,7 +1274,7 @@ The direction of the ICU transform. Valid options are `forward` and `reverse`.</analyzer>----====---+======For detailed information about ICU Transforms, see http://userguide.icu-project.org/transforms/general.@@ -1309,11 +1327,11 @@ Where `keepwords.txt` contains:`happy funny silly`-[.dynamic-tabs]----[example.tab-pane#byname-filter-keepword]+[tabs#filter-keepword]+======+With name::++====-[.tab-label]*With name*[source,xml]----<analyzer>@@ -1322,9 +1340,10 @@ Where `keepwords.txt` contains:</analyzer>----====-[example.tab-pane#byclass-filter-keepword]++With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<analyzer>@@ -1333,7 +1352,7 @@ Where `keepwords.txt` contains:</analyzer>----====---+======*In:* "Happy, sad or funny"@@ -1392,11 +1411,11 @@ This stemmer is only appropriate for English language text.*Example:*-[.dynamic-tabs]----[example.tab-pane#byname-filter-kstem]+[tabs#filter-kstem]+======+With name::++====-[.tab-label]*With name*[source,xml]----<analyzer type="index">@@ -1405,9 +1424,10 @@ This stemmer is only appropriate for English language text.</analyzer>----====-[example.tab-pane#byclass-filter-kstem]++With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<analyzer type="index">@@ -1416,7 +1436,7 @@ This stemmer is only appropriate for English language text.</analyzer>----====---+======*In:* "jump jumping jumped"@@ -1455,11 +1475,11 @@ Tokens longer than this are discarded.*Example:*-[.dynamic-tabs]----[example.tab-pane#byname-filter-length]+[tabs#filter-length]+======+With name::++====-[.tab-label]*With name*[source,xml]----<analyzer>@@ -1468,9 +1488,10 @@ Tokens longer than this are discarded.</analyzer>----====-[example.tab-pane#byclass-filter-length]++With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<analyzer>@@ -1479,7 +1500,7 @@ Tokens longer than this are discarded.</analyzer>----====---+======*In:* "turn right at Albuquerque"@@ -1521,11 +1542,11 @@ See description above.*Example:*-[.dynamic-tabs]----[example.tab-pane#byname-filter-limittokencount]+[tabs#filter-limittokencount]+======+With name::++====-[.tab-label]*With name*[source,xml]----<analyzer type="index">@@ -1535,9 +1556,10 @@ See description above.</analyzer>----====-[example.tab-pane#byclass-filter-limittokencount]++With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<analyzer type="index">@@ -1547,7 +1569,7 @@ See description above.</analyzer>----====---+======*In:* "1 2 3 4 5 6 7 8 9 10 11 12"@@ -1590,11 +1612,11 @@ See description above.*Example:*-[.dynamic-tabs]----[example.tab-pane#byname-filter-limittokenoffset]+[tabs#filter-limittokenoffset]+======+With name::++====-[.tab-label]*With name*[source,xml]----<analyzer>@@ -1604,9 +1626,10 @@ See description above.</analyzer>----====-[example.tab-pane#byclass-filter-limittokenoffset]++With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<analyzer>@@ -1616,7 +1639,7 @@ See description above.</analyzer>----====---+======*In:* "0 2 4 6 8 A C E"@@ -1658,11 +1681,11 @@ See description above.*Example:*-[.dynamic-tabs]----[example.tab-pane#byname-filter-limittokenposition]+[tabs#filter-limittokenposition]+======+With name::++====-[.tab-label]*With name*[source,xml]----<analyzer>@@ -1672,9 +1695,10 @@ See description above.</analyzer>----====-[example.tab-pane#byclass-filter-limittokenposition]++With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<analyzer>@@ -1684,7 +1708,7 @@ See description above.</analyzer>----====---+======*In:* "1 2 3 4 5"@@ -1703,11 +1727,11 @@ All other characters are left unchanged.*Example:*-[.dynamic-tabs]----[example.tab-pane#byname-filter-lowercase]+[tabs#filter-lowercase]+======+With name::++====-[.tab-label]*With name*[source,xml]----<analyzer>@@ -1716,9 +1740,10 @@ All other characters are left unchanged.</analyzer>----====-[example.tab-pane#byclass-filter-lowercase]++With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<analyzer>@@ -1727,7 +1752,7 @@ All other characters are left unchanged.</analyzer>----====---+======*In:* "Down With CamelCase"@@ -1754,11 +1779,11 @@ The name that should be used for this set of stop words in the managed REST API.//TODO: make this show an actual API call.With this configuration the set of words is named "english" and can be managed via `/solr/collection_name/schema/analysis/stopwords/english`-[.dynamic-tabs]----[example.tab-pane#byname-filter-managedstop]+[tabs#filter-managedstop]+======+With name::++====-[.tab-label]*With name*[source,xml]----<analyzer>@@ -1767,9 +1792,10 @@ With this configuration the set of words is named "english" and can be managed v</analyzer>----====-[example.tab-pane#byclass-filter-managedstop]++With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<analyzer>@@ -1778,7 +1804,7 @@ With this configuration the set of words is named "english" and can be managed v</analyzer>----====---+======See <<Stop Filter>> for example input/output.@@ -1820,11 +1846,11 @@ The name that should be used for this mapping on synonyms in the managed REST AP//TODO: make this show an actual API callWith this configuration the set of mappings is named "english" and can be managed via `/solr/collection_name/schema/analysis/synonyms/english`-[.dynamic-tabs]----[example.tab-pane#byname-filter-managedsynonymgraph]+[tabs#filter-managed-synonymgrpah]+======+With name::++====-[.tab-label]*With name*[source,xml]----<analyzer type="index">@@ -1838,9 +1864,10 @@ With this configuration the set of mappings is named "english" and can be manage</analyzer>----====-[example.tab-pane#byclass-filter-managedsynonymgraph]++With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<analyzer type="index">@@ -1854,7 +1881,7 @@ With this configuration the set of mappings is named "english" and can be manage</analyzer>----====---+======See <<Synonym Graph Filter>> below for example input/output.@@ -1915,11 +1942,11 @@ With the default settings for `withRotation`, the number of hashes generated is*Example:*-[.dynamic-tabs]----[example.tab-pane#byname-filter-minhash]+[tabs#filter-minhash]+======+With name::++====-[.tab-label]*With name*[source,xml]----<analyzer>@@ -1930,9 +1957,10 @@ With the default settings for `withRotation`, the number of hashes generated is</analyzer>----====-[example.tab-pane#byclass-filter-minhash]++With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<analyzer>@@ -1943,7 +1971,7 @@ With the default settings for `withRotation`, the number of hashes generated is</analyzer>----====---+======*In:* "woof woof woof woof woof"@@ -1990,11 +2018,11 @@ If `true` keep the original term even if it is shorter than `minGramSize` or lonDefault behavior.-[.dynamic-tabs]----[example.tab-pane#byname-filter-ngram]+[tabs#filter-ngram]+======+With name::++====-[.tab-label]*With name*[source,xml]----<analyzer>@@ -2003,9 +2031,10 @@ Default behavior.</analyzer>----====-[example.tab-pane#byclass-filter-ngram]++With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<analyzer>@@ -2014,7 +2043,7 @@ Default behavior.</analyzer>----====---+======*In:* "four score"@@ -2106,11 +2135,11 @@ Tokens with a matching type name will have their payload set to the above floati*Example:*-[.dynamic-tabs]----[example.tab-pane#byname-filter-numericpayload]+[tabs#filter-numericpayload]+======+With name::++====-[.tab-label]*With name*[source,xml]----<analyzer>@@ -2119,9 +2148,10 @@ Tokens with a matching type name will have their payload set to the above floati</analyzer>----====-[example.tab-pane#byclass-filter-numericpayload]++With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<analyzer>@@ -2130,7 +2160,7 @@ Tokens with a matching type name will have their payload set to the above floati</analyzer>----====---+======*In:* "bing bang boom"@@ -2180,11 +2210,11 @@ Indicates whether all occurrences of the pattern (`all`) in the token should beSimple string replace:-[.dynamic-tabs]----[example.tab-pane#byname-filter-patternreplace]+[tabs#filter-patternreplace]+======+With name::++====-[.tab-label]*With name*[source,xml]----<analyzer>@@ -2193,9 +2223,10 @@ Simple string replace:</analyzer>----====-[example.tab-pane#byclass-filter-patternreplace]++With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<analyzer>@@ -2204,7 +2235,7 @@ Simple string replace:</analyzer>----====---+======*In:* "cat concatenate catycat"@@ -2300,11 +2331,11 @@ The maximum length of the code to be generated by the Metaphone or Double MetaphDefault behavior for DoubleMetaphone encoding.-[.dynamic-tabs]----[example.tab-pane#byname-filter-phonetic]+[tabs#filter-phonetic]+======+With name::++====-[.tab-label]*With name*[source,xml]----<analyzer>@@ -2313,9 +2344,10 @@ Default behavior for DoubleMetaphone encoding.</analyzer>----====-[example.tab-pane#byclass-filter-phonetic]++With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<analyzer>@@ -2324,7 +2356,7 @@ Default behavior for DoubleMetaphone encoding.</analyzer>----====---+======*In:* "four score and twenty"@@ -2384,11 +2416,11 @@ However, it has been benchmarked as http://markmail.org/thread/d2c443z63z37rwf6[*Example:*-[.dynamic-tabs]----[example.tab-pane#byname-filter-porterstem]+[tabs#filter-porterstem]+======+With name::++====-[.tab-label]*With name*[source,xml]----<analyzer type="index">@@ -2397,9 +2429,10 @@ However, it has been benchmarked as http://markmail.org/thread/d2c443z63z37rwf6[</analyzer>----====-[example.tab-pane#byclass-filter-porterstem]++With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<analyzer type="index">@@ -2408,7 +2441,7 @@ However, it has been benchmarked as http://markmail.org/thread/d2c443z63z37rwf6[</analyzer>----====---+======*In:* "jump jumping jumped"@@ -2457,11 +2490,11 @@ If `true`, the protected list should contain lowercase words.All terms except those in `protectedTerms.txt` are truncated at 4 characters and lowercased:-[.dynamic-tabs]----[example.tab-pane#byname-filter-protectedterm]+[tabs]+======+With name::++====-[.tab-label]*With name*[source,xml]----<analyzer>@@ -2473,9 +2506,10 @@ All terms except those in `protectedTerms.txt` are truncated at 4 characters and</analyzer>----====-[example.tab-pane#byclass-filter-protectedterm]++With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<analyzer>@@ -2487,7 +2521,7 @@ All terms except those in `protectedTerms.txt` are truncated at 4 characters and</analyzer>----====---+======*Example:*@@ -2535,11 +2569,11 @@ Consider the following entry from a `synonyms.txt` file:When used in the following configuration:-[.dynamic-tabs]----[example.tab-pane#byname-filter-removeduplicates]+[tabs#filter-removeduplicates]+======+With name::++====-[.tab-label]*With name*[source,xml]----<analyzer type="query">@@ -2550,9 +2584,10 @@ When used in the following configuration:</analyzer>----====-[example.tab-pane#byclass-filter-removeduplicates]++With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<analyzer type="query">@@ -2563,7 +2598,7 @@ When used in the following configuration:</analyzer>----====---+======*In:* "Watch TV"@@ -2634,11 +2669,11 @@ For good performance this should be set to a value larger than `1`.*Example:*-[.dynamic-tabs]----[example.tab-pane#byname-filter-reversedwildcard]+[tabs#filter-reversedwildcard]+======+With name::++====-[.tab-label]*With name*[source,xml]----<analyzer type="index">@@ -2648,9 +2683,10 @@ For good performance this should be set to a value larger than `1`.</analyzer>----====-[example.tab-pane#byclass-filter-reversedwildcard]++With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<analyzer type="index">@@ -2660,7 +2696,7 @@ For good performance this should be set to a value larger than `1`.</analyzer>----====---+======*In:* "*foo *bar"@@ -2737,11 +2773,11 @@ The character used to fill in for removed stop words in order to preserve positiDefault behavior.-[.dynamic-tabs]----[example.tab-pane#byname-filter-shingle]+[tabs#filter-shingle]+======+With name::++====-[.tab-label]*With name*[source,xml]----<analyzer>@@ -2750,9 +2786,10 @@ Default behavior.</analyzer>----====-[example.tab-pane#byclass-filter-shingle]++With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<analyzer>@@ -2761,7 +2798,7 @@ Default behavior.</analyzer>----====---+======*In:* "To be, or what?"@@ -2830,11 +2867,11 @@ This may be an absolute path, or a simple file name in the Solr `conf` directoryDefault behavior:-[.dynamic-tabs]----[example.tab-pane#byname-filter-snowball]+[tabs#filter-snowball]+======+With name::++====-[.tab-label]*With name*[source,xml]----<analyzer>@@ -2843,9 +2880,10 @@ Default behavior:</analyzer>----====-[example.tab-pane#byclass-filter-snowball]++With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<analyzer>@@ -2854,7 +2892,7 @@ Default behavior:</analyzer>----====---+======*In:* "flip flipped flipping"@@ -2942,11 +2980,11 @@ If `true`, the stop list should contain lowercase words.Case-sensitive matching, capitalized words not stopped.Token positions skip stopped words.-[.dynamic-tabs]----[example.tab-pane#byname-filter-stop]+[tabs#filter-stop]+======+With name::++====-[.tab-label]*With name*[source,xml]----<analyzer>@@ -2955,9 +2993,10 @@ Token positions skip stopped words.</analyzer>----====-[example.tab-pane#byclass-filter-stop]++With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<analyzer>@@ -2966,7 +3005,7 @@ Token positions skip stopped words.</analyzer>----====---+======*In:* "To be or what?"@@ -3040,11 +3079,11 @@ If `true`, matching is case-insensitive.*Example:*-[.dynamic-tabs]----[example.tab-pane#byname-filter-suggeststop]+[tabs#filter-suggeststop]+======+With name::++====-[.tab-label]*With name*[source,xml]----<analyzer type="query">@@ -3055,9 +3094,10 @@ If `true`, matching is case-insensitive.</analyzer>----====-[example.tab-pane#byclass-filter-suggeststop]++With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<analyzer type="query">@@ -3068,7 +3108,7 @@ If `true`, matching is case-insensitive.</analyzer>----====---+======*In:* "The The"@@ -3193,11 +3233,11 @@ small => tiny,teeny,weeny*Example:*-[.dynamic-tabs]----[example.tab-pane#byname-filter-stop-synonymgraph]+[tabs#filter-stop-synonymgraph]+======+With name::++====-[.tab-label]*With name*[source,xml]----<analyzer type="index">@@ -3211,9 +3251,9 @@ small => tiny,teeny,weeny</analyzer>----====-[example.tab-pane#byclass-filter-stop-synonymgraph]+With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<analyzer type="index">@@ -3227,7 +3267,7 @@ small => tiny,teeny,weeny</analyzer>----====---+======*In:* "teh small couch"@@ -3286,11 +3326,11 @@ This filter adds the numeric character offsets of the token as a payload value f*Example:*-[.dynamic-tabs]----[example.tab-pane#byname-filter-stop-tokenoffsetpayload]+[tabs#filter-stop-tokenoffsetpayload]+======+With name::++====-[.tab-label]*With name*[source,xml]----<analyzer>@@ -3299,9 +3339,10 @@ This filter adds the numeric character offsets of the token as a payload value f</analyzer>----====-[example.tab-pane#byclass-filter-stop-tokenoffsetpayload]++With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<analyzer>@@ -3310,7 +3351,7 @@ This filter adds the numeric character offsets of the token as a payload value f</analyzer>----====---+======*In:* "bing bang boom"@@ -3331,11 +3372,11 @@ Most tokenizers break tokens at whitespace, so this filter is most often used foThe PatternTokenizerFactory configuration used here splits the input on simple commas, it does not remove whitespace.-[.dynamic-tabs]----[example.tab-pane#byname-filter-trim]+[tabs#filter-trim]+======+With name::++====-[.tab-label]*With name*[source,xml]----<analyzer>@@ -3344,9 +3385,10 @@ The PatternTokenizerFactory configuration used here splits the input on simple c</analyzer>----====-[example.tab-pane#byclass-filter-trim]++With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<analyzer>@@ -3355,7 +3397,7 @@ The PatternTokenizerFactory configuration used here splits the input on simple c</analyzer>----====---+======*In:* "one, two , three ,four "@@ -3373,11 +3415,11 @@ This filter adds the token's type, as an encoded byte sequence, as its payload.*Example:*-[.dynamic-tabs]----[example.tab-pane#byname-filter-typeaspayload]+[tabs#filter-typeaspayload]+======+With name::++====-[.tab-label]*With name*[source,xml]----<analyzer>@@ -3386,9 +3428,10 @@ This filter adds the token's type, as an encoded byte sequence, as its payload.</analyzer>----====-[example.tab-pane#byclass-filter-typeaspayload]++With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<analyzer>@@ -3397,7 +3440,7 @@ This filter adds the token's type, as an encoded byte sequence, as its payload.</analyzer>----====---+======*In:* "Pay Bob's I.O.U."@@ -3445,11 +3488,11 @@ The default value is an integer `-1`, i.e., the mask `0xFFFFFFFF` - this mask prWith the example below, each token's type will be emitted verbatim at the same position:-[.dynamic-tabs]----[example.tab-pane#byname-filter-typeassynonym]+[tabs#filter-typeassynonym]+======+With name::++====-[.tab-label]*With name*[source,xml]----<analyzer>@@ -3458,9 +3501,10 @@ With the example below, each token's type will be emitted verbatim at the same p</analyzer>----====-[example.tab-pane#byclass-filter-typeassynonym]++With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<analyzer>@@ -3469,15 +3513,15 @@ With the example below, each token's type will be emitted verbatim at the same p</analyzer>----====---+======With the example below, for a token "example.com" with type `<URL>`, the token emitted at the same position will be "\_type_<URL>":-[.dynamic-tabs]----[example.tab-pane#byname-filter-typeassynonym-args]+[tabs#filter-typeassynonym-args]+======+With name::++====-[.tab-label]*With name*[source,xml]----<analyzer>@@ -3486,9 +3530,10 @@ With the example below, for a token "example.com" with type `<URL>`, the token e</analyzer>----====-[example.tab-pane#byclass-filter-typeassynonym-args]++With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<analyzer>@@ -3497,7 +3542,7 @@ With the example below, for a token "example.com" with type `<URL>`, the token e</analyzer>----====---+======== Type Token Filter@@ -3530,11 +3575,11 @@ If `false`, or undefined, the file defined in `types` is used as a denylist.*Example:*-[.dynamic-tabs]----[example.tab-pane#byname-filter-typetoken]+[tabs#filter-typetoken]+======+With name::++====-[.tab-label]*With name*[source,xml]----<analyzer>@@ -3542,9 +3587,10 @@ If `false`, or undefined, the file defined in `types` is used as a denylist.</analyzer>----====-[example.tab-pane#byclass-filter-typetoken]++With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<analyzer>@@ -3552,7 +3598,7 @@ If `false`, or undefined, the file defined in `types` is used as a denylist.</analyzer>----====---+======== Word Delimiter Filter@@ -3726,11 +3772,11 @@ $ => DIGITDefault behavior.The whitespace tokenizer is used here to preserve non-alphanumeric characters.-[.dynamic-tabs]----[example.tab-pane#byname-filter-worddelimitergraph]+[tabs#filter-worddelimitergraph]+======+With name::++====-[.tab-label]*With name*[source,xml]----<analyzer type="index">@@ -3744,9 +3790,9 @@ The whitespace tokenizer is used here to preserve non-alphanumeric characters.</analyzer>----====-[example.tab-pane#byclass-filter-worddelimitergraph]+With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<analyzer type="index">@@ -3760,7 +3806,7 @@ The whitespace tokenizer is used here to preserve non-alphanumeric characters.</analyzer>----====---+======*In:* "hot-spot RoboBlaster/9000 100XL"diff --git a/solr/solr-ref-guide/modules/indexing-guide/pages/indexing-nested-documents.adoc b/solr/solr-ref-guide/modules/indexing-guide/pages/indexing-nested-documents.adocindex 43347c59c28..939f8f2adc5 100644--- a/solr/solr-ref-guide/modules/indexing-guide/pages/indexing-nested-documents.adoc+++ b/solr/solr-ref-guide/modules/indexing-guide/pages/indexing-nested-documents.adoc@@ -1,4 +1,5 @@= Indexing Nested Documents+:tabs-sync-option:// Licensed to the Apache Software Foundation (ASF) under one// or more contributor license agreements. See the NOTICE file// distributed with this work for additional information@@ -60,11 +61,11 @@ There is no "child document" field type.// DO NOT MODIFY THESE EXAMPLE DOCS WITHOUT REVIEWING ALL PAGES THAT INCLUDE/REFER BACK TO THESE EXAMPLES// INCLUDING THE SEMI-EQUIVALENT ANONYMOUS CHILDREN EXAMPLE AT THE BOTTOM OF THIS PAGE//-[.dynamic-tabs]----[example.tab-pane#json]+[tabs#sample-indexing-deeply-nested-documents]+======+JSON::++====-[.tab-label]*JSON*// tag::sample-indexing-deeply-nested-documents[][source,json]----@@ -126,9 +127,9 @@ The xref:indexing-with-update-handlers#json-update-convenience-paths[`/update/js=========-[example.tab-pane#xml]+XML::++====-[.tab-label]*XML*[source,xml]----<add>@@ -208,15 +209,15 @@ The xref:indexing-with-update-handlers#json-update-convenience-paths[`/update/js----====-[example.tab-pane#solrj]+SolrJ::++====-[.tab-label]*SolrJ*[source,java,indent=0]----include::example$IndexingNestedDocuments.java[tag=nest-path]----====---+======== Schema Configuration@@ -307,11 +308,11 @@ If you use Solr's delete-by-query APIs, you *MUST* be careful to ensure that anyAlthough not recommended, it is also possible to index child documents "anonymously":-[.dynamic-tabs]----[example.tab-pane#anon_json]+[tabs#anon]+======+JSON::++====-[.tab-label]*JSON*[source,json]----[{ "id": "P11!prod",@@ -353,9 +354,9 @@ Although not recommended, it is also possible to index child documents "anonymou----====-[example.tab-pane#anon_xml]+XML::++====-[.tab-label]*XML*[source,xml]----<add>@@ -402,17 +403,15 @@ Although not recommended, it is also possible to index child documents "anonymou----====-[example.tab-pane#anon_solrj]+SolrJ::++====-[.tab-label]*SolrJ*[source,java,indent=0]----include::example$IndexingNestedDocuments.java[tag=anon-kids]----====-----+======This simplified approach was common in older versions of Solr, and can still be used with "Root-Only" schemas that do not contain any other nested related fields apart from `\_root_`.Many schemas in existence are this way simply because default configsets are this way, even if the application isn't using nested documents.@@ -422,11 +421,11 @@ This approach should *NOT* be used when schemas include a `\_nest_path_` field,The results of indexing anonymous nested children with a "Root-Only" schema are similar to what happens if you attempt to index "pseudo field" nested documents using a "Root-Only" schema.Notably: since there is no nested path information for the xref:query-guide:searching-nested-documents.adoc#child-doc-transformer[`[child]`] transformer to use to reconstruct the structure of a nest of documents, it returns all matching children as a flat list, similar in structure to how they were originally indexed:-[.dynamic-tabs]----[example.tab-pane#anon_json_out]+[tabs#anon-out]+======+JSON::++====-[.tab-label]*JSON*[source,bash]----$ curl --globoff 'http://localhost:8983/solr/gettingstarted/select?omitHeader=true&q=id:P11!prod&fl=*,[child%20parentFilter=%22type_s:PRODUCT%22]'@@ -475,10 +474,9 @@ $ curl --globoff 'http://localhost:8983/solr/gettingstarted/select?omitHeader=tr}}----====--[example.tab-pane#anon_xml_out]+XML::++====-[.tab-label]*XML*[source,bash]----$ curl --globoff 'http://localhost:8983/solr/gettingstarted/select?omitHeader=true&q=id:P11!prod&fl=*,[child%20parentFilter=%22type_s:PRODUCT%22]&wt=xml'@@ -529,6 +527,4 @@ $ curl --globoff 'http://localhost:8983/solr/gettingstarted/select?omitHeader=tr</response>----====-----+======diff --git a/solr/solr-ref-guide/modules/indexing-guide/pages/language-analysis.adoc b/solr/solr-ref-guide/modules/indexing-guide/pages/language-analysis.adocindex 669b40d674b..fa60ebad0d0 100644--- a/solr/solr-ref-guide/modules/indexing-guide/pages/language-analysis.adoc+++ b/solr/solr-ref-guide/modules/indexing-guide/pages/language-analysis.adoc@@ -1,4 +1,5 @@= Language Analysis+:tabs-sync-option:// Licensed to the Apache Software Foundation (ASF) under one// or more contributor license agreements. See the NOTICE file// distributed with this work for additional information@@ -34,11 +35,11 @@ Any words in the protected word list will not be modified by any stemmer in SolrA sample Solr `protwords.txt` with comments can be found in the `sample_techproducts_configs` xref:configuration-guide:config-sets.adoc[configset] directory:-[.dynamic-tabs]----[example.tab-pane#byname-filter-keywordmarker]+[tabs#filter-keywordmarker]+======+With name::++====-[.tab-label]*With name*[source,xml]----<fieldtype name="myfieldtype" class="solr.TextField">@@ -50,9 +51,10 @@ A sample Solr `protwords.txt` with comments can be found in the `sample_techprod</fieldtype>----====-[example.tab-pane#byclass-filter-keywordmarker]++With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<fieldtype name="myfieldtype" class="solr.TextField">@@ -64,7 +66,7 @@ A sample Solr `protwords.txt` with comments can be found in the `sample_techprod</fieldtype>----====---+======== KeywordRepeatFilterFactory@@ -79,11 +81,11 @@ It is recommended to also include `RemoveDuplicatesTokenFilterFactory` to avoidA sample fieldType configuration could look like this:-[.dynamic-tabs]----[example.tab-pane#byname-filter-keywordrepeat]+[tabs#filter-keyowrdrepeat]+======+With name::++====-[.tab-label]*With name*[source,xml]----<fieldtype name="english_stem_preserve_original" class="solr.TextField">@@ -96,9 +98,10 @@ A sample fieldType configuration could look like this:</fieldtype>----====-[example.tab-pane#byclass-filter-keywordrepeat]++With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<fieldtype name="english_stem_preserve_original" class="solr.TextField">@@ -111,7 +114,7 @@ A sample fieldType configuration could look like this:</fieldtype>----====---+======IMPORTANT: When adding the same token twice, it will also score twice (double), so you may have to re-tune your ranking rules.@@ -123,11 +126,11 @@ Overrides stemming algorithms by applying a custom mapping, then protecting thesA customized mapping of words to stems, in a tab-separated file, can be specified to the `dictionary` attribute in the schema.Words in this mapping will be stemmed to the stems from the file, and will not be further changed by any stemmer.-[.dynamic-tabs]----[example.tab-pane#byname-filter-stemmeroverride]+[tabs#filter-stemmeroverrider]+======+With name::++====-[.tab-label]*With name*[source,xml]----<fieldtype name="myfieldtype" class="solr.TextField">@@ -139,9 +142,10 @@ Words in this mapping will be stemmed to the stems from the file, and will not b</fieldtype>----====-[example.tab-pane#byclass-filter-stemmeroverride]++With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<fieldtype name="myfieldtype" class="solr.TextField">@@ -153,7 +157,7 @@ Words in this mapping will be stemmed to the stems from the file, and will not b</fieldtype>----====---+======A sample `stemdict.txt` file is shown below:@@ -228,11 +232,11 @@ If `true`, only the longest matching subwords will generate new tokens.Assume that `germanwords.txt` contains at least the following words: `dumm kopf donau dampf schiff`-[.dynamic-tabs]----[example.tab-pane#byname-filter-dictionarycompoundword]+[tabs#filter-dictionary-compoundword]+======+With name::++====-[.tab-label]*With name*[source,xml]----<analyzer>@@ -241,9 +245,10 @@ Assume that `germanwords.txt` contains at least the following words: `dumm kopf</analyzer>----====-[example.tab-pane#byclass-filter-dictionarycompoundword]++With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<analyzer>@@ -252,7 +257,7 @@ Assume that `germanwords.txt` contains at least the following words: `dumm kopf</analyzer>----====---+======*In:* "Donaudampfschiff dummkopf"@@ -620,11 +625,11 @@ On the other hand, it can reduce precision because language-specific character d*Example:*-[.dynamic-tabs]----[example.tab-pane#byname-filter-lang-asciifolding]+[tabs#filter-lang-asciifolding]+======+With name::++====-[.tab-label]*With name*[source,xml]----<analyzer>@@ -633,9 +638,10 @@ On the other hand, it can reduce precision because language-specific character d</analyzer>----====-[example.tab-pane#byclass-filter-lang-asciifolding]++With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<analyzer>@@ -644,7 +650,7 @@ On the other hand, it can reduce precision because language-specific character d</analyzer>----====---+======*In:* "Björn Ångström"@@ -665,11 +671,11 @@ On the other hand, it can reduce precision because language-specific character d*Example:*-[.dynamic-tabs]----[example.tab-pane#byname-filter-decimaldigit]+[tabs#filter-decimaldigit]+======+With name::++====-[.tab-label]*With name*[source,xml]----<analyzer>@@ -678,9 +684,10 @@ On the other hand, it can reduce precision because language-specific character d</analyzer>----====-[example.tab-pane#byclass-filter-decimaldigit]++With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<analyzer>@@ -689,7 +696,7 @@ On the other hand, it can reduce precision because language-specific character d</analyzer>----====---+======== OpenNLP Integration@@ -736,11 +743,11 @@ See xref:configuration-guide:resource-loading.adoc[] for more information.*Example:*-[.dynamic-tabs]----[example.tab-pane#byname-tokenizer-opennlp]+[tabs#tokenizer-opennlp]+======+With name::++====-[.tab-label]*With name*[source,xml]----<analyzer>@@ -750,9 +757,10 @@ See xref:configuration-guide:resource-loading.adoc[] for more information.</analyzer>----====-[example.tab-pane#byclass-tokenizer-opennlp]++With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<analyzer>@@ -762,7 +770,7 @@ See xref:configuration-guide:resource-loading.adoc[] for more information.</analyzer>----====---+========= OpenNLP Part-Of-Speech Filter@@ -806,11 +814,11 @@ $Index the POS for each token as a payload:-[.dynamic-tabs]----[example.tab-pane#byname-filter-opennlppos]+[tabs#filter-opennlppos]+======+With name::++====-[.tab-label]*With name*[source,xml]----<analyzer>@@ -823,9 +831,10 @@ Index the POS for each token as a payload:</analyzer>----====-[example.tab-pane#byclass-filter-opennlppos]++With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<analyzer>@@ -838,7 +847,7 @@ Index the POS for each token as a payload:</analyzer>----====---+======Index the POS for each token as a synonym, after prefixing the POS with "@" (see the xref:filters.adoc#type-as-synonym-filter[TypeAsSynonymFilter description]):@@ -895,11 +904,11 @@ See xref:configuration-guide:resource-loading.adoc[] for more information.Index the phrase chunk label for each token as a payload:-[.dynamic-tabs]----[example.tab-pane#byname-filter-opennlpchunker]+[tabs#filter-opennlpchunker]+======+With name::++====-[.tab-label]*With name*[source,xml]----<analyzer>@@ -912,9 +921,10 @@ Index the phrase chunk label for each token as a payload:</analyzer>----====-[example.tab-pane#byclass-filter-opennlpchunker]++With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<analyzer>@@ -927,7 +937,7 @@ Index the phrase chunk label for each token as a payload:</analyzer>----====---+======Index the phrase chunk label for each token as a synonym, after prefixing it with "#" (see the xref:filters.adoc#type-as-synonym-filter[TypeAsSynonymFilter description]):@@ -981,11 +991,11 @@ See xref:configuration-guide:resource-loading.adoc[] for more information.Perform dictionary-based lemmatization, and fall back to model-based lemmatization for out-of-vocabulary tokens (see the <<OpenNLP Part-Of-Speech Filter>> section above for information about using `TypeTokenFilter` to avoid indexing punctuation):-[.dynamic-tabs]----[example.tab-pane#byname-filter-opennlplemmatizer]+[tabs#filter-opennlplemmatizer]+======+With name::++====-[.tab-label]*With name*[source,xml]----<analyzer>@@ -1000,9 +1010,10 @@ Perform dictionary-based lemmatization, and fall back to model-based lemmatizati</analyzer>----====-[example.tab-pane#byclass-filter-opennlplemmatizer]++With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<analyzer>@@ -1017,7 +1028,7 @@ Perform dictionary-based lemmatization, and fall back to model-based lemmatizati</analyzer>----====---+======Perform dictionary-based lemmatization only:@@ -1111,11 +1122,11 @@ This algorithm defines both character normalization and stemming, so these are s*Example:*-[.dynamic-tabs]----[example.tab-pane#byname-lang-arabic]+[tabs#lang-arabic]+======+With name::++====-[.tab-label]*With name*[source,xml]----<analyzer>@@ -1125,9 +1136,9 @@ This algorithm defines both character normalization and stemming, so these are s</analyzer>----====-[example.tab-pane#byclass-lang-arabic]+With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<analyzer>@@ -1137,7 +1148,7 @@ This algorithm defines both character normalization and stemming, so these are s</analyzer>----====---+========= Bengali@@ -1150,11 +1161,11 @@ They use the Lucene classes `org.apache.lucene.analysis.bn.BengaliNormalizationF*Example:*-[.dynamic-tabs]----[example.tab-pane#byname-lang-bengali]+[tabs#lang-bengali]+======+With name::++====-[.tab-label]*With name*[source,xml]----<analyzer>@@ -1164,9 +1175,10 @@ They use the Lucene classes `org.apache.lucene.analysis.bn.BengaliNormalizationF</analyzer>----====-[example.tab-pane#byclass-lang-bengali]++With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<analyzer>@@ -1176,7 +1188,7 @@ They use the Lucene classes `org.apache.lucene.analysis.bn.BengaliNormalizationF</analyzer>----====---+======*Normalisation* - `মানুষ` -> `মানুস`@@ -1195,11 +1207,11 @@ Although that stemmer can be configured to use a list of protected words (which*Example:*-[.dynamic-tabs]----[example.tab-pane#byname-lang-brazilian]+[tabs#lang-brazilian]+======+With name::++====-[.tab-label]*With name*[source,xml]----<analyzer type="index">@@ -1208,9 +1220,10 @@ Although that stemmer can be configured to use a list of protected words (which</analyzer>----====-[example.tab-pane#byclass-lang-brazilian]++With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<analyzer type="index">@@ -1219,7 +1232,7 @@ Although that stemmer can be configured to use a list of protected words (which</analyzer>----====---+======*In:* "praia praias"@@ -1237,11 +1250,11 @@ Solr includes a light stemmer for Bulgarian, following http://members.unine.ch/j*Example:*-[.dynamic-tabs]----[example.tab-pane#byname-lang-bulgarian]+[tabs#lang-bulgarian]+======+With name::++====-[.tab-label]*With name*[source,xml]----<analyzer>@@ -1251,9 +1264,10 @@ Solr includes a light stemmer for Bulgarian, following http://members.unine.ch/j</analyzer>----====-[example.tab-pane#byclass-lang-bulgarian]++With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<analyzer>@@ -1263,7 +1277,7 @@ Solr includes a light stemmer for Bulgarian, following http://members.unine.ch/j</analyzer>----====---+========= Catalan@@ -1285,11 +1299,11 @@ The stemmer language, `Catalan` in this case.*Example:*-[.dynamic-tabs]----[example.tab-pane#byname-lang-catalan]+[tabs#lang-catalan]+======+With name::++====-[.tab-label]*With name*[source,xml]----<analyzer>@@ -1301,9 +1315,10 @@ The stemmer language, `Catalan` in this case.</analyzer>----====-[example.tab-pane#byclass-lang-catalan]++With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<analyzer>@@ -1315,7 +1330,7 @@ The stemmer language, `Catalan` in this case.</analyzer>----====---+======*In:* "llengües llengua"@@ -1338,11 +1353,11 @@ When combined with <<CJK Bigram Filter>>, overlapping bigrams of Chinese charact*Examples:*-[.dynamic-tabs]----[example.tab-pane#byname-lang-trd-chinese]+[tabs#lang-trd-chinese]+======+With name::++====-[.tab-label]*With name*[source,xml]----<analyzer>@@ -1352,9 +1367,10 @@ When combined with <<CJK Bigram Filter>>, overlapping bigrams of Chinese charact</analyzer>----====-[example.tab-pane#byclass-lang-trad-chinese]++With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<analyzer>@@ -1364,7 +1380,7 @@ When combined with <<CJK Bigram Filter>>, overlapping bigrams of Chinese charact</analyzer>----====---+======[source,xml]----@@ -1453,11 +1469,11 @@ Also useful for Chinese analysis:*Examples:*-[.dynamic-tabs]----[example.tab-pane#byname-lang-chinese]+[tabs#lang-chinese]+======+With name::++====-[.tab-label]*With name*[source,xml]----<analyzer>@@ -1470,9 +1486,10 @@ Also useful for Chinese analysis:</analyzer>----====-[example.tab-pane#byclass-lang-chinese]++With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<analyzer>@@ -1485,7 +1502,7 @@ Also useful for Chinese analysis:</analyzer>----====---+======[source,xml]----@@ -1527,33 +1544,34 @@ Solr includes a light stemmer for Czech, following https://dl.acm.org/citation.c*Example:*-[.dynamic-tabs]----[example.tab-pane#byname-lang-czech]+[tabs#lang-czech]+======+With name::++====-[.tab-label]*With name*[source,xml]----<analyzer><tokenizer name="standard"/><filter name="lowercase"/><filter name="czechStem"/>-<analyzer>+</analyzer>----====-[example.tab-pane#byclass-lang-czech]++With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<analyzer><tokenizer class="solr.StandardTokenizerFactory"/><filter class="solr.LowerCaseFilterFactory"/><filter class="solr.CzechStemFilterFactory"/>-<analyzer>+</analyzer>----====---+======*In:* "prezidenští, prezidenta, prezidentského"@@ -1582,11 +1600,11 @@ The stemmer language, `Danish` in this case.*Example:*-[.dynamic-tabs]----[example.tab-pane#byname-lang-danish]+[tabs#lang-danish]+======+With name::++====-[.tab-label]*With name*[source,xml]----<analyzer>@@ -1596,9 +1614,10 @@ The stemmer language, `Danish` in this case.</analyzer>----====-[example.tab-pane#byclass-lang-danish]++With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<analyzer>@@ -1608,7 +1627,7 @@ The stemmer language, `Danish` in this case.</analyzer>----====---+======*In:* "undersøg undersøgelse"@@ -1635,11 +1654,11 @@ The stemmer language, `Dutch` in this case.*Example:*-[.dynamic-tabs]----[example.tab-pane#byname-lang-dutch]+[tabs#lang-dutch]+======+With name::++====-[.tab-label]*With name*[source,xml]----<analyzer type="index">@@ -1649,9 +1668,10 @@ The stemmer language, `Dutch` in this case.</analyzer>----====-[example.tab-pane#byclass-lang-dutch]++With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<analyzer type="index">@@ -1661,7 +1681,7 @@ The stemmer language, `Dutch` in this case.</analyzer>----====---+======*In:* "kanaal kanalen"@@ -1688,11 +1708,11 @@ The stemmer language, `Estonian` in this case.*Example:*-[.dynamic-tabs]----[example.tab-pane#byname-lang-estonian]+[tabs#lang-estonian]+======+With name::++====-[.tab-label]*With name*[source,xml]----<analyzer type="index">@@ -1702,9 +1722,10 @@ The stemmer language, `Estonian` in this case.</analyzer>----====-[example.tab-pane#byclass-lang-estonian]++With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<analyzer type="index">@@ -1714,7 +1735,7 @@ The stemmer language, `Estonian` in this case.</analyzer>----====---+======*In:* "Taevani tõustes"@@ -1732,11 +1753,12 @@ Solr includes support for stemming Finnish, and Lucene includes an example stopw*Example:*-[.dynamic-tabs]----[example.tab-pane#byname-lang-finnish]+[tabs#lang-finnish]+======++With name::++====-[.tab-label]*With name*[source,xml]----<analyzer type="index">@@ -1745,9 +1767,10 @@ Solr includes support for stemming Finnish, and Lucene includes an example stopw</analyzer>----====-[example.tab-pane#byclass-lang-finnish]++With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<analyzer type="index">@@ -1756,7 +1779,7 @@ Solr includes support for stemming Finnish, and Lucene includes an example stopw</analyzer>----====---+======*In:* "kala kalat"@@ -1800,11 +1823,11 @@ If `true`, the filter ignores the case of words when comparing them to the commo*Example:*-[.dynamic-tabs]----[example.tab-pane#byname-lang-french]+[tabs#lang-french]+======+With name::++====-[.tab-label]*With name*[source,xml]----<analyzer>@@ -1815,9 +1838,10 @@ If `true`, the filter ignores the case of words when comparing them to the commo</analyzer>----====-[example.tab-pane#byclass-lang-french]++With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<analyzer>@@ -1828,7 +1852,7 @@ If `true`, the filter ignores the case of words when comparing them to the commo</analyzer>----====---+======*In:* "L'histoire d'art"@@ -1886,11 +1910,11 @@ Solr includes a stemmer for Galician following http://bvg.udc.es/recursos_lingua*Example:*-[.dynamic-tabs]----[example.tab-pane#byname-lang-galician]+[tabs#lang-galician]+======+With name::++====-[.tab-label]*With name*[source,xml]----<analyzer>@@ -1900,9 +1924,10 @@ Solr includes a stemmer for Galician following http://bvg.udc.es/recursos_lingua</analyzer>----====-[example.tab-pane#byclass-lang-galician]++With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<analyzer>@@ -1912,7 +1937,7 @@ Solr includes a stemmer for Galician following http://bvg.udc.es/recursos_lingua</analyzer>----====---+======*In:* "felizmente Luzes"@@ -1931,11 +1956,11 @@ Lucene includes an example stopword list.*Examples:*-[.dynamic-tabs]----[example.tab-pane#byname-lang-german]+[tabs#lang-german]+======+With name::++====-[.tab-label]*With name*[source,xml]----<analyzer type="index">@@ -1944,9 +1969,10 @@ Lucene includes an example stopword list.</analyzer>----====-[example.tab-pane#byclass-lang-german]++With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<analyzer type="index">@@ -1955,7 +1981,7 @@ Lucene includes an example stopword list.</analyzer>----====---+======[source,xml]----@@ -1995,11 +2021,11 @@ If you need to index text in these encodings, please use Java's character set co*Example:*-[.dynamic-tabs]----[example.tab-pane#byname-lang-greek]+[tabs#lang-greek]+======+With name::++====-[.tab-label]*With name*[source,xml]----<analyzer type="index">@@ -2008,9 +2034,10 @@ If you need to index text in these encodings, please use Java's character set co</analyzer>----====-[example.tab-pane#byclass-lang-greek]++With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<analyzer type="index">@@ -2019,7 +2046,7 @@ If you need to index text in these encodings, please use Java's character set co</analyzer>----====---+========= Hindi@@ -2031,11 +2058,11 @@ Solr includes support for stemming Hindi following http://computing.open.ac.uk/S*Example:*-[.dynamic-tabs]----[example.tab-pane#byname-lang-hindi]+[tabs#lang-hindi]+======+With name::++====-[.tab-label]*With name*[source,xml]----<analyzer type="index">@@ -2046,9 +2073,10 @@ Solr includes support for stemming Hindi following http://computing.open.ac.uk/S</analyzer>----====-[example.tab-pane#byclass-lang-hindi]++With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<analyzer type="index">@@ -2059,7 +2087,7 @@ Solr includes support for stemming Hindi following http://computing.open.ac.uk/S</analyzer>----====---+========= Indonesian@@ -2071,11 +2099,11 @@ Solr includes support for stemming Indonesian (Bahasa Indonesia) following http:*Example:*-[.dynamic-tabs]----[example.tab-pane#byname-lang-indonesian]+[tabs#lang-indonesian]+======+With name::++====-[.tab-label]*With name*[source,xml]----<analyzer>@@ -2085,9 +2113,10 @@ Solr includes support for stemming Indonesian (Bahasa Indonesia) following http:</analyzer>----====-[example.tab-pane#byclass-lang-indonesian]++With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<analyzer>@@ -2097,7 +2126,7 @@ Solr includes support for stemming Indonesian (Bahasa Indonesia) following http:</analyzer>----====---+======*In:* "sebagai sebagainya"@@ -2116,11 +2145,11 @@ Lucene includes an example stopword list.*Example:*-[.dynamic-tabs]----[example.tab-pane#byname-lang-italian]+[tabs#lang-italian]+======+With name::++====-[.tab-label]*With name*[source,xml]----<analyzer>@@ -2132,9 +2161,10 @@ Lucene includes an example stopword list.</analyzer>----====-[example.tab-pane#byclass-lang-italian]++With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<analyzer>@@ -2146,7 +2176,7 @@ Lucene includes an example stopword list.</analyzer>----====---+======*In:* "propaga propagare propagamento"@@ -2175,11 +2205,11 @@ The stemmer language, `Irish` in this case.*Example:*-[.dynamic-tabs]----[example.tab-pane#byname-lang-irish]+[tabs#lang-irish]+======+With name::++====-[.tab-label]*With name*[source,xml]----<analyzer>@@ -2191,9 +2221,10 @@ The stemmer language, `Irish` in this case.</analyzer>----====-[example.tab-pane#byclass-lang-irish]++With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<analyzer>@@ -2205,7 +2236,7 @@ The stemmer language, `Irish` in this case.</analyzer>----====---+======*In:* "siopadóireacht síceapatacha b'fhearr m'athair"@@ -2376,11 +2407,11 @@ Folds fullwidth ASCII variants into the equivalent Basic Latin forms, and foldsExample:-[.dynamic-tabs]----[example.tab-pane#byname-lang-japanese]+[tabs#lang-japanese]+======+With name::++====-[.tab-label]*With name*[source,xml]----<fieldType name="text_ja" positionIncrementGap="100" autoGeneratePhraseQueries="false">@@ -2398,9 +2429,10 @@ Example:</fieldType>----====-[example.tab-pane#byclass-lang-japanese]++With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<fieldType name="text_ja" positionIncrementGap="100" autoGeneratePhraseQueries="false">@@ -2418,7 +2450,7 @@ Example:</fieldType>----====---+========= Korean@@ -2431,11 +2463,11 @@ Nori also has a user dictionary feature that allows overriding the statistical m*Example*:-[.dynamic-tabs]----[example.tab-pane#byname-lang-korean]+[tabs#lang-korean]+======+With name::++====-[.tab-label]*With name*[source,xml]----<fieldType name="text_ko" class="solr.TextField" positionIncrementGap="100">@@ -2449,9 +2481,9 @@ Nori also has a user dictionary feature that allows overriding the statistical m----====-[example.tab-pane#byclass-lang-korean]+With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<fieldType name="text_ko" class="solr.TextField" positionIncrementGap="100">@@ -2464,7 +2496,7 @@ Nori also has a user dictionary feature that allows overriding the statistical m</fieldType>----====---+========== Korean Tokenizer@@ -2562,11 +2594,11 @@ Solr includes support for stemming Latvian, and Lucene includes an example stopw*Example:*-[.dynamic-tabs]----[example.tab-pane#byname-lang-latvian]+[tabs#lang-latvian]+======+With name::++====-[.tab-label]*With name*[source,xml]----<fieldType name="text_lvstem" class="solr.TextField" positionIncrementGap="100">@@ -2578,9 +2610,10 @@ Solr includes support for stemming Latvian, and Lucene includes an example stopw</fieldType>----====-[example.tab-pane#byclass-lang-latvian]++With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<fieldType name="text_lvstem" class="solr.TextField" positionIncrementGap="100">@@ -2592,7 +2625,7 @@ Solr includes support for stemming Latvian, and Lucene includes an example stopw</fieldType>----====---+======*In:* "tirgiem tirgus"@@ -2651,11 +2684,11 @@ Valid values are:*Example:*-[.dynamic-tabs]----[example.tab-pane#byname-lang-norweigian]+[tabs#lang-norweigian]+======+With name::++====-[.tab-label]*With name*[source,xml]----<fieldType name="text_no" class="solr.TextField" positionIncrementGap="100">@@ -2668,9 +2701,10 @@ Valid values are:</fieldType>----====-[example.tab-pane#byclass-lang-norweigian]++With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<fieldType name="text_no" class="solr.TextField" positionIncrementGap="100">@@ -2683,7 +2717,7 @@ Valid values are:</fieldType>----====---+======*In:* "Forelskelsen"@@ -2744,11 +2778,11 @@ This is a variant of `ScandinavianNormalizationFilter`, with folding rules custo*Example:*-[.dynamic-tabs]----[example.tab-pane#byname-lang-norwegian]+[tabs#lang-norwegian]+======+With name::++====-[.tab-label]*With name*[source,xml]----<analyzer>@@ -2758,9 +2792,10 @@ This is a variant of `ScandinavianNormalizationFilter`, with folding rules custo</analyzer>----====-[example.tab-pane#byclass-lang-norwegian]++With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<analyzer>@@ -2770,7 +2805,7 @@ This is a variant of `ScandinavianNormalizationFilter`, with folding rules custo</analyzer>----====---+======*In:* "blåbærsyltetøj blåbärsyltetöj blaabaarsyltetoej blabarsyltetoj"@@ -2790,11 +2825,11 @@ Solr includes support for normalizing Persian, and Lucene includes an example st*Example:*-[.dynamic-tabs]----[example.tab-pane#byname-lang-persian]+[tabs#lang-persian]+======+With name::++====-[.tab-label]*With name*[source,xml]----<analyzer>@@ -2804,9 +2839,10 @@ Solr includes support for normalizing Persian, and Lucene includes an example st</analyzer>----====-[example.tab-pane#byclass-lang-persian]++With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<analyzer>@@ -2816,7 +2852,7 @@ Solr includes support for normalizing Persian, and Lucene includes an example st</analyzer>----====---+========= Polish@@ -2830,11 +2866,11 @@ To use this tokenizer, you must enable the xref:#analysis-extras-module[analysis*Example:*-[.dynamic-tabs]----[example.tab-pane#byname-lang-polish]+[tabs#lang-polish]+======+With name::++====-[.tab-label]*With name*[source,xml]----<analyzer>@@ -2844,9 +2880,10 @@ To use this tokenizer, you must enable the xref:#analysis-extras-module[analysis</analyzer>----====-[example.tab-pane#byclass-lang-polish]++With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<analyzer>@@ -2856,7 +2893,7 @@ To use this tokenizer, you must enable the xref:#analysis-extras-module[analysis</analyzer>----====---+======[source,xml]----@@ -2893,11 +2930,11 @@ Lucene includes an example stopword list.*Example:*-[.dynamic-tabs]----[example.tab-pane#byname-lang-portuguese]+[tabs#lang-portuguese]+======+With name::++====-[.tab-label]*With name*[source,xml]----<analyzer>@@ -2907,9 +2944,10 @@ Lucene includes an example stopword list.</analyzer>----====-[example.tab-pane#byclass-lang-portuguese]++With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<analyzer>@@ -2919,7 +2957,7 @@ Lucene includes an example stopword list.</analyzer>----====---+======[source,xml]----@@ -2964,11 +3002,11 @@ The stemmer language, `Romanian` in this case.*Example:*-[.dynamic-tabs]----[example.tab-pane#byname-lang-romanian]+[tabs#lang-romanian]+======+With name::++====-[.tab-label]*With name*[source,xml]----<analyzer>@@ -2978,9 +3016,10 @@ The stemmer language, `Romanian` in this case.</analyzer>----====-[example.tab-pane#byclass-lang-romanian]++With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<analyzer>@@ -2990,7 +3029,7 @@ The stemmer language, `Romanian` in this case.</analyzer>----====---+========= Russian@@ -3005,11 +3044,11 @@ Lucene includes an example stopword list.*Example:*-[.dynamic-tabs]----[example.tab-pane#byname-lang-russian]+[tabs#lang-russian]+======+With name::++====-[.tab-label]*With name*[source,xml]----<analyzer type="index">@@ -3019,9 +3058,10 @@ Lucene includes an example stopword list.</analyzer>----====-[example.tab-pane#byclass-lang-russian]++With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<analyzer type="index">@@ -3031,7 +3071,7 @@ Lucene includes an example stopword list.</analyzer>----====---+========= Scandinavian@@ -3061,11 +3101,11 @@ This filter does *not* perform the common Swedish folds of å and ä to a nor ö*Example:*-[.dynamic-tabs]----[example.tab-pane#byname-lang-scandinavian]+[tabs#lang-scandinavian]+======+With name::++====-[.tab-label]*With name*[source,xml]----<analyzer>@@ -3075,9 +3115,10 @@ This filter does *not* perform the common Swedish folds of å and ä to a nor ö</analyzer>----====-[example.tab-pane#byclass-lang-scandinavian]++With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<analyzer>@@ -3087,7 +3128,7 @@ This filter does *not* perform the common Swedish folds of å and ä to a nor ö</analyzer>----====---+======*In:* "blåbærsyltetøj blåbärsyltetöj blaabaarsyltetoej blabarsyltetoj"@@ -3151,11 +3192,11 @@ Valid values are:*Example:*-[.dynamic-tabs]----[example.tab-pane#byname-lang-serbian]+[tabs#lang-serbian]+======+With name::++====-[.tab-label]*With name*[source,xml]----<analyzer>@@ -3165,9 +3206,10 @@ Valid values are:</analyzer>----====-[example.tab-pane#byclass-lang-serbian]++With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<analyzer>@@ -3177,7 +3219,7 @@ Valid values are:</analyzer>----====---+========= Spanish@@ -3190,11 +3232,11 @@ Lucene includes an example stopword list.*Example:*-[.dynamic-tabs]----[example.tab-pane#byname-lang-spanish]+[tabs#lang-spanish]+======+With name::++====-[.tab-label]*With name*[source,xml]----<analyzer>@@ -3204,9 +3246,10 @@ Lucene includes an example stopword list.</analyzer>----====-[example.tab-pane#byclass-lang-spanish]++With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<analyzer>@@ -3216,7 +3259,7 @@ Lucene includes an example stopword list.</analyzer>----====---+======*In:* "torear toreara torearlo"@@ -3249,11 +3292,11 @@ Also relevant are the <<Scandinavian,Scandinavian normalization filters>>.*Example (SwedishLightStemFilterFactory):*-[.dynamic-tabs]----[example.tab-pane#byname-lang-swedish]+[tabs#lang-swedish]+======+With name::++====-[.tab-label]*With name*[source,xml]----<analyzer>@@ -3263,9 +3306,10 @@ Also relevant are the <<Scandinavian,Scandinavian normalization filters>>.</analyzer>----====-[example.tab-pane#byclass-lang-swedish]++With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<analyzer>@@ -3275,7 +3319,7 @@ Also relevant are the <<Scandinavian,Scandinavian normalization filters>>.</analyzer>----====---+======*In:* "kloke klokhet klokheten"@@ -3294,11 +3338,11 @@ Unlike European languages, Thai does not use whitespace to delimit words.*Example:*-[.dynamic-tabs]----[example.tab-pane#byname-lang-thai]+[tabs#lang-thai]+======+With name::++====-[.tab-label]*With name*[source,xml]----<analyzer type="index">@@ -3307,9 +3351,10 @@ Unlike European languages, Thai does not use whitespace to delimit words.</analyzer>----====-[example.tab-pane#byclass-lang-thai]++With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<analyzer type="index">@@ -3318,7 +3363,7 @@ Unlike European languages, Thai does not use whitespace to delimit words.</analyzer>----====---+========= Turkish@@ -3330,11 +3375,11 @@ Solr includes support for stemming Turkish with the `solr.SnowballPorterFilterFa*Example:*-[.dynamic-tabs]----[example.tab-pane#byname-lang-turkish]+[tabs#lang-turkish]+======+With name::++====-[.tab-label]*With name*[source,xml]----<analyzer>@@ -3345,9 +3390,10 @@ Solr includes support for stemming Turkish with the `solr.SnowballPorterFilterFa</analyzer>----====-[example.tab-pane#byclass-lang-turkish]++With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<analyzer>@@ -3358,7 +3404,7 @@ Solr includes support for stemming Turkish with the `solr.SnowballPorterFilterFa</analyzer>----====---+======*Another example, illustrating diacritics-insensitive search:*@@ -3398,11 +3444,11 @@ The `lucene-analyzers-morfologik` jar contains a Ukrainian dictionary at `org/ap*Example:*-[.dynamic-tabs]----[example.tab-pane#byname-lang-ukranian]+[tabs#lang-ukranian]+======+With name::++====-[.tab-label]*With name*[source,xml]----<analyzer>@@ -3413,9 +3459,10 @@ The `lucene-analyzers-morfologik` jar contains a Ukrainian dictionary at `org/ap</analyzer>----====-[example.tab-pane#byclass-lang-ukranian]++With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<analyzer>@@ -3426,7 +3473,7 @@ The `lucene-analyzers-morfologik` jar contains a Ukrainian dictionary at `org/ap</analyzer>----====---+======The Morfologik `dictionary` parameter value is a constant specifying which dictionary to choose.The dictionary resource must be named `path/to/_language_.dict` and have an associated `.info` metadata file.diff --git a/solr/solr-ref-guide/modules/indexing-guide/pages/schema-api.adoc b/solr/solr-ref-guide/modules/indexing-guide/pages/schema-api.adocindex 7cda29859c4..683f6f41fd5 100644--- a/solr/solr-ref-guide/modules/indexing-guide/pages/schema-api.adoc+++ b/solr/solr-ref-guide/modules/indexing-guide/pages/schema-api.adoc@@ -1,4 +1,5 @@= Schema API+:tabs-sync-option:// Licensed to the Apache Software Foundation (ASF) under one// or more contributor license agreements. See the NOTICE file// distributed with this work for additional information@@ -100,11 +101,11 @@ These request attributes are described in detail in the section xref:fields.adocFor example, to define a new stored field named "sell_by", of type "pdate", you would POST the following request:-[.dynamic-tabs]----[example.tab-pane#v1add]+[tabs#add-request]+======+V1 API::++====-[.tab-label]*V1 API*[source,bash]----curl -X POST -H 'Content-type:application/json' --data-binary '{@@ -116,9 +117,9 @@ curl -X POST -H 'Content-type:application/json' --data-binary '{----====-[example.tab-pane#v2add]+V2 API::++====-[.tab-label]*V2 API*[source,bash]----curl -X POST -H 'Content-type:application/json' --data-binary '{@@ -129,7 +130,7 @@ curl -X POST -H 'Content-type:application/json' --data-binary '{}' http://localhost:8983/api/collections/techproducts/schema----====---+========= Delete a Field@@ -138,11 +139,11 @@ If the field does not exist in the schema, or if the field is the source or destFor example, to delete a field named "sell_by", you would POST the following request:-[.dynamic-tabs]----[example.tab-pane#v1delete]+[tabs#delete-request]+======+V1 API::++====-[.tab-label]*V1 API*[source,bash]----curl -X POST -H 'Content-type:application/json' --data-binary '{@@ -151,9 +152,9 @@ curl -X POST -H 'Content-type:application/json' --data-binary '{----====-[example.tab-pane#v2delete]+V2 API::++====-[.tab-label]*V2 API*[source,bash]----curl -X POST -H 'Content-type:application/json' --data-binary '{@@ -161,7 +162,7 @@ curl -X POST -H 'Content-type:application/json' --data-binary '{}' http://localhost:8983/api/collections/techproducts/schema----====---+========= Replace a Field@@ -174,11 +175,11 @@ These request attributes are described in detail in the section xref:fields.adocFor example, to replace the definition of an existing field "sell_by", to make it be of type "date" and to not be stored, you would POST the following request:-[.dynamic-tabs]----[example.tab-pane#v1replace]+[tabs#replace-request]+======+V1 API::++====-[.tab-label]*V1 API*[source,bash]----curl -X POST -H 'Content-type:application/json' --data-binary '{@@ -190,9 +191,9 @@ curl -X POST -H 'Content-type:application/json' --data-binary '{----====-[example.tab-pane#v2replace]+V2 API::++====-[.tab-label]*V2 API*[source,bash]----curl -X POST -H 'Content-type:application/json' --data-binary '{@@ -203,7 +204,7 @@ curl -X POST -H 'Content-type:application/json' --data-binary '{}' http://localhost:8983/api/collections/techproducts/schema----====---+========= Add a Dynamic Field Rule@@ -214,11 +215,11 @@ The section xref:dynamic-fields.adoc[] has details on all of the attributes thatFor example, to create a new dynamic field rule where all incoming fields ending with "_s" would be stored and have field type "string", you can POST a request like this:-[.dynamic-tabs]----[example.tab-pane#v1add-dynamic]+[tabs#add-dynamic-request]+======+V1 API::++====-[tab-label]*V1 API*[source,bash]----curl -X POST -H 'Content-type:application/json' --data-binary '{@@ -230,9 +231,9 @@ curl -X POST -H 'Content-type:application/json' --data-binary '{----====-[example.tab-pane#v2add-dynamic]+V2 API::++====-[tab-label]*V2 API*[source,bash]----curl -X POST -H 'Content-type:application/json' --data-binary '{@@ -243,7 +244,7 @@ curl -X POST -H 'Content-type:application/json' --data-binary '{}' http://localhost:8983/api/collections/techproducts/schema----====---+========= Delete a Dynamic Field Rule@@ -252,11 +253,11 @@ If the dynamic field rule does not exist in the schema, or if the schema containFor example, to delete a dynamic field rule matching "*_s", you can POST a request like this:-[.dynamic-tabs]----[example.tab-pane#v1delete-dynamic]+[tabs#delete-dynamic-request]+======+V1 API::++====-[.tab-label]*V1 API*[source,bash]----curl -X POST -H 'Content-type:application/json' --data-binary '{@@ -265,9 +266,9 @@ curl -X POST -H 'Content-type:application/json' --data-binary '{----====-[example.tab-pane#v2delete-dynamic]+V2 API::++====-[.tab-label]*V2 API*[source,bash]----curl -X POST -H 'Content-type:application/json' --data-binary '{@@ -275,7 +276,7 @@ curl -X POST -H 'Content-type:application/json' --data-binary '{}' http://localhost:8983/api/collections/techproducts/schema----====---+========= Replace a Dynamic Field Rule@@ -288,11 +289,11 @@ The section xref:dynamic-fields.adoc[] has details on all of the attributes thatFor example, to replace the definition of the "*_s" dynamic field rule with one where the field type is "text_general" and it's not stored, you can POST a request like this:-[.dynamic-tabs]----[example.tab-pane#v1replace-dynamic]+[tabs#replace-dynamic-request]+======+V1 API::++====-[.tab-label]*V1 API*[source,bash]----curl -X POST -H 'Content-type:application/json' --data-binary '{@@ -304,9 +305,9 @@ curl -X POST -H 'Content-type:application/json' --data-binary '{----====-[example.tab-pane#v2replace-dynamic]+V2 API::++====-[.tab-label]*V2 API*[source,bash]----curl -X POST -H 'Content-type:application/json' --data-binary '{@@ -317,7 +318,7 @@ curl -X POST -H 'Content-type:application/json' --data-binary '{}' http://localhost:8983/solr/techproducts/schema----====---+========= Add a New Field Type@@ -329,11 +330,11 @@ Details of all of the available options are described in the section xref:field-For example, to create a new field type named "myNewTxtField", you can POST a request as follows:-[.dynamic-tabs]----[example.tab-pane#v1-single-analyzer]+[tabs#single-analyzer-request]+======+V1 API with Single Analysis::++====-[tab-label]*V1 API with Single Analysis*[source,bash]----curl -X POST -H 'Content-type:application/json' --data-binary '{@@ -357,10 +358,9 @@ curl -X POST -H 'Content-type:application/json' --data-binary '{Note in this example that we have only defined a single analyzer section that will apply to index analysis and query analysis.====-[example.tab-pane#v1-two-analyzers]+V1 API with Two Analyzers::++====-[tab-label]*V1 API with Two Analyzers*-If we wanted to define separate analysis, we would replace the `analyzer` section in the above example with separate sections for `indexAnalyzer` and `queryAnalyzer`.As in this example:@@ -381,10 +381,9 @@ curl -X POST -H 'Content-type:application/json' --data-binary '{----====-[example.tab-pane#v2-two-analyzers]+V2 API with Two Analyzers::++====-[tab-label]*V2 API with Two Analyzers*-To define two analyzers with the V2 API, we just use a different endpoint:[source,bash]----@@ -402,7 +401,7 @@ curl -X POST -H 'Content-type:application/json' --data-binary '{}' http://localhost:8983/api/collections/techproducts/schema----====---+========= Delete a Field Type@@ -411,11 +410,11 @@ If the field type does not exist in the schema, or if any field or dynamic fieldFor example, to delete the field type named "myNewTxtField", you can make a POST request as follows:-[.dynamic-tabs]----[example.tab-pane#v1delete-type]+[tabs#delete-type-request]+======+V1 API::++====-[tab-label]*V1 API*[source,bash]----curl -X POST -H 'Content-type:application/json' --data-binary '{@@ -424,9 +423,9 @@ curl -X POST -H 'Content-type:application/json' --data-binary '{----====-[example.tab-pane#v2delete-type]+V2 API::++====-[tab-label]*V2 API*[source,bash]----curl -X POST -H 'Content-type:application/json' --data-binary '{@@ -434,7 +433,7 @@ curl -X POST -H 'Content-type:application/json' --data-binary '{}' http://localhost:8983/api/collections/techproducts/schema----====---+========= Replace a Field Type@@ -448,11 +447,11 @@ Details of all of the available options are described in the section xref:field-For example, to replace the definition of a field type named "myNewTxtField", you can make a POST request as follows:-[.dynamic-tabs]----[example.tab-pane#v1replace-type]+[tabs#replace-type-request]+======+V1 API::++====-[tab-label]*V1 API*[source,bash]----curl -X POST -H 'Content-type:application/json' --data-binary '{@@ -467,9 +466,9 @@ curl -X POST -H 'Content-type:application/json' --data-binary '{----====-[example.tab-pane#v2replace-type]+V2 API::++====-[tab-label]*V2 API*[source,bash]----curl -X POST -H 'Content-type:application/json' --data-binary '{@@ -483,7 +482,7 @@ curl -X POST -H 'Content-type:application/json' --data-binary '{}' http://localhost:8983/api/collections/techproducts/schema----====---+========= Add a New Copy Field Rule@@ -521,11 +520,11 @@ The section xref:copy-fields.adoc[] has more details.For example, to define a rule to copy the field "shelf" to the "location" and "catchall" fields, you would POST the following request:-[.dynamic-tabs]----[example.tab-pane#v1add-copyfield]+[tabs#add-copyfield-request]+======+V1 API::++====-[.tab-label]*V1 API*[source,bash]----curl -X POST -H 'Content-type:application/json' --data-binary '{@@ -536,9 +535,9 @@ curl -X POST -H 'Content-type:application/json' --data-binary '{----====-[example.tab-pane#v2add-copyfield]+V2 API::++====-[.tab-label]*V2 API*[source,bash]----curl -X POST -H 'Content-type:application/json' --data-binary '{@@ -548,7 +547,7 @@ curl -X POST -H 'Content-type:application/json' --data-binary '{}' http://localhost:8983/api/collections/techproducts/schema----====---+========= Delete a Copy Field Rule@@ -559,11 +558,11 @@ The `source` and `dest` attributes are required by this command.For example, to delete a rule to copy the field "shelf" to the "location" field, you would POST the following request:-[.dynamic-tabs]----[example.tab-pane#v1delete-copyfield]+[tabs#delete-copyfield-request]+======+V1 API::++====-[tab-label]*V1 API*[source,bash]----curl -X POST -H 'Content-type:application/json' --data-binary '{@@ -572,9 +571,9 @@ curl -X POST -H 'Content-type:application/json' --data-binary '{----====-[example.tab-pane#v2delete-copyfield]+V2 API::++====-[tab-label]*V2 API*[source,bash]----curl -X POST -H 'Content-type:application/json' --data-binary '{@@ -582,7 +581,7 @@ curl -X POST -H 'Content-type:application/json' --data-binary '{}' http://localhost:8983/api/collections/techproducts/schema----====---+========= Multiple Commands in a Single POST@@ -854,7 +853,8 @@ curl http://localhost:8983/solr/techproducts/schema?wt=schema.xml<filter class="solr.PatternReplaceFilterFactory" replace="all" replacement="" pattern="([^a-z])"/></analyzer></fieldType>-...+ ...+ </types><copyField source="url" dest="text"/><copyField source="price" dest="price_c"/><copyField source="author" dest="author_s"/>@@ -948,27 +948,27 @@ See the section xref:fields.adoc[] for more information about each parameter.==== List Fields Examples-[.dynamic-tabs]----[example.tab-pane#v1list-fields]+[tabs#list-fields-request]+======+V1 API::++====-[tab-label]*V1 API*[source,bash]----http://localhost:8983/solr/techproducts/schema/fields----====-[example.tab-pane#v2list-fields]+V2 API::++====-[tab-label]*V2 API*[source,bash]----curl -X GET "http://localhost:8983/api/collections/techproducts/schema/fields"----====---+======The sample output below has been truncated to only show a few fields.@@ -1066,27 +1066,27 @@ See the section xref:dynamic-fields.adoc[] for more information about each paramGet a list of all dynamic field declarations:-[.dynamic-tabs]----[example.tab-pane#v1list-dynamicfields]+[tabs#dynamicfields-request]+======+V1 API::++====-[tab-label]*V1 API*[source,bash]----http://localhost:8983/techproducts/schema/dynamicfields----====-[example.tab-pane#v2list-dynamicfields]+V2 API::++====-[tab-label]*V2 API*[source,bash]----curl -X GET "http://localhost:8983/api/collections/techproducts/schema/dynamicfields"----====---+======The sample output below has been truncated.@@ -1122,7 +1122,7 @@ The sample output below has been truncated."name": "*_txt","stored": true,"type": "text_general"- }+ },"..."],"responseHeader": {@@ -1195,26 +1195,26 @@ See the section xref:field-type-definitions-and-properties.adoc[] for more inforGet a list of all field types.-[.dynamic-tabs]----[example.tab-pane#v1list-fieldtypes]+[tabs#list-fieldtypes-request]+======+V1 API::++====-[tab-label]*V1 API*[source,bash]----curl http://localhost:8983/solr/techproducts/schema/fieldtypes----====-[example.tab-pane#v2list-fieldtypes]+V2 API::++====-[tab-label]*V2 API*[source,bash]----curl -X GET "http://localhost:8983/api/collections/techproducts/schema/fieldtypes"----====---+======The sample output below has been truncated to show a few different field types from different parts of the list.@@ -1318,26 +1318,26 @@ For more information about copy fields, see the section xref:copy-fields.adoc[].Get a list of all copyFields.-[.dynamic-tabs]----[example.tab-pane#v1list-copyfields]+[tabs#list-copyfields-request]+======+V1 API::++====-[tab-label]*V1 API*[source,bash]----curl http://localhost:8983/solr/techproducts/schema/copyfields----====-[example.tab-pane#v2list-copyfields]+V2 API::++====-[tab-label]*V2 API*[source,bash]----curl -X GET "http://localhost:8983/api/collections/techproducts/schema/copyfields"----====---+======The sample output below has been truncated to the first few copy definitions.@@ -1360,7 +1360,7 @@ The sample output below has been truncated to the first few copy definitions.{"dest": "text","source": "content_type"- },+ }],"responseHeader": {"QTime": 3,@@ -1408,26 +1408,26 @@ The output will be simply the name given to the schema.Get the schema name.-[.dynamic-tabs]----[example.tab-pane#v1list-schemaname]+[tabs#list-schemaname-request]+======+V1 API::++====-[tab-label]*V1 API*[source,bash]----curl http://localhost:8983/solr/techproducts/schema/name----====-[example.tab-pane#v2list-schemaname]+V2 API::++====-[tab-label]*V2 API*[source,bash]----curl -X GET "http://localhost:8983/api/collections/techproducts/schema/name"----====---+======[source,json]@@ -1478,26 +1478,26 @@ The output will simply be the schema version in use.Get the schema version:-[.dynamic-tabs]----[example.tab-pane#v1list-schemaversion]+[tabs#list-schemaversion-request]+======+V1 API::++====-[tab-label]*V1 API*[source,bash]----curl http://localhost:8983/solr/techproducts/schema/version----====-[example.tab-pane#v2list-schemaversion]+V2 API::++====-[tab-label]*V2 API*[source,bash]----curl -X GET "http://localhost:8983/api/collections/techproducts/schema/version"----====---+======[source,json]----@@ -1547,26 +1547,26 @@ The output will include simply the field name that is defined as the uniqueKey fList the uniqueKey.-[.dynamic-tabs]----[example.tab-pane#v1list-schemauniquekey]+[tabs#list-schemauniquekey-request]+======+V1 API::++====-[tab-label]*V1 API*[source,bash]----curl http://localhost:8983/solr/techproducts/schema/uniquekey----====-[example.tab-pane#v2list-schemauniquekey]+V2 API::++====-[tab-label]*V2 API*[source,bash]----curl -X GET "http://localhost:8983/api/collections/techproducts/schema/uniquekey"----====---+======[source,json]----@@ -1616,26 +1616,26 @@ The output will include the class name of the global similarity defined (if any)Get the similarity implementation.-[.dynamic-tabs]----[example.tab-pane#v1list-schemasimilarity]+[tabs#list-schemasimilarity-request]+======+V1 API::++====-[tab-label]*V1 API*[source,bash]----curl http://localhost:8983/solr/techproducts/schema/similarity----====-[example.tab-pane#v2list-schemasimilarity]+V2 API::++====-[tab-label]*V2 API*[source,bash]----curl -X GET "http://localhost:8983/api/collections/techproducts/schema/similarity"----====---+======[source,json]----diff --git a/solr/solr-ref-guide/modules/indexing-guide/pages/tokenizers.adoc b/solr/solr-ref-guide/modules/indexing-guide/pages/tokenizers.adocindex fbb69399efc..3c5aef1e523 100644--- a/solr/solr-ref-guide/modules/indexing-guide/pages/tokenizers.adoc+++ b/solr/solr-ref-guide/modules/indexing-guide/pages/tokenizers.adoc@@ -1,4 +1,5 @@= Tokenizers+:tabs-sync-option:// Licensed to the Apache Software Foundation (ASF) under one// or more contributor license agreements. See the NOTICE file// distributed with this work for additional information@@ -33,11 +34,11 @@ Keep this in mind if you use token metadata for things like highlighting search== About TokenizersYou configure the tokenizer for a text field type in the xref:schema-elements.adoc[schema] with a `<tokenizer>` element, as a child of `<analyzer>`:-[.dynamic-tabs]----[example.tab-pane#byname-tokenizer]+[tabs#tokenizer]+======+With name::++====-[.tab-label]*With name*[source,xml]----<fieldType name="text" class="solr.TextField">@@ -48,9 +49,10 @@ You configure the tokenizer for a text field type in the xref:schema-elements.ad</fieldType>----====-[example.tab-pane#byclass-tokenizer]++With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<fieldType name="text" class="solr.TextField">@@ -61,7 +63,7 @@ You configure the tokenizer for a text field type in the xref:schema-elements.ad</fieldType>----====---+======The name/class attribute names a factory class that will instantiate a tokenizer object when needed.Tokenizer factory classes implement the `org.apache.lucene.analysis.TokenizerFactory`.@@ -70,11 +72,11 @@ When Solr creates the tokenizer it passes a Reader object that provides the contArguments may be passed to tokenizer factories by setting attributes on the `<tokenizer>` element.-[.dynamic-tabs]----[example.tab-pane#byname-tokenizer-args]+[tabs#tokenizer-args]+======+With name::++====-[.tab-label]*With name*[source,xml]----<fieldType name="semicolonDelimited" class="solr.TextField">@@ -84,9 +86,10 @@ Arguments may be passed to tokenizer factories by setting attributes on the `<to</fieldType>----====-[example.tab-pane#byclass-tokenizer-args]++With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<fieldType name="semicolonDelimited" class="solr.TextField">@@ -96,7 +99,7 @@ Arguments may be passed to tokenizer factories by setting attributes on the `<to</fieldType>----====---+========= When to Use a CharFilter vs. a TokenFilter@@ -136,11 +139,11 @@ Solr ignores tokens that exceed the number of characters specified by `maxTokenL*Example:*-[.dynamic-tabs]----[example.tab-pane#byname-tokenizer-standard]+[tabs#tokenizer-standard]+======+With name::++====-[.tab-label]*With name*[source,xml]----<analyzer>@@ -148,9 +151,10 @@ Solr ignores tokens that exceed the number of characters specified by `maxTokenL</analyzer>----====-[example.tab-pane#byclass-tokenizer-standard]++With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<analyzer>@@ -158,7 +162,7 @@ Solr ignores tokens that exceed the number of characters specified by `maxTokenL</analyzer>----====---+======*In:* "Please, email [email protected] by 03-09, re: m37-xq."@@ -192,11 +196,12 @@ Solr ignores tokens that exceed the number of characters specified by `maxTokenL*Example:*-[.dynamic-tabs]----[example.tab-pane#byname-tokenizer-classic]+[tabs#tokenizer-classic]+======++With name::++====-[.tab-label]*With name*[source,xml]----<analyzer>@@ -204,9 +209,10 @@ Solr ignores tokens that exceed the number of characters specified by `maxTokenL</analyzer>----====-[example.tab-pane#byclass-tokenizer-classic]++With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<analyzer>@@ -214,7 +220,7 @@ Solr ignores tokens that exceed the number of characters specified by `maxTokenL</analyzer>----====---+======*In:* "Please, email [email protected] by 03-09, re: m37-xq."@@ -239,11 +245,11 @@ Maximum token length the tokenizer will emit.*Example:*-[.dynamic-tabs]----[example.tab-pane#byname-tokenizer-keyword]+[tabs#tokenizer-keyword]+======+With name::++====-[.tab-label]*With name*[source,xml]----<analyzer>@@ -251,9 +257,10 @@ Maximum token length the tokenizer will emit.</analyzer>----====-[example.tab-pane#byclass-tokenizer-keyword]++With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<analyzer>@@ -261,7 +268,7 @@ Maximum token length the tokenizer will emit.</analyzer>----====---+======*In:* "Please, email [email protected] by 03-09, re: m37-xq."@@ -286,11 +293,11 @@ Maximum token length the tokenizer will emit.*Example:*-[.dynamic-tabs]----[example.tab-pane#byname-tokenizer-letter]+[tabs#tokenizer-letter]+======+With name::++====-[.tab-label]*With name*[source,xml]----<analyzer>@@ -298,9 +305,10 @@ Maximum token length the tokenizer will emit.</analyzer>----====-[example.tab-pane#byclass-tokenizer-letter]++With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<analyzer>@@ -308,7 +316,7 @@ Maximum token length the tokenizer will emit.</analyzer>----====---+======*In:* "I can't."@@ -334,11 +342,11 @@ Maximum token length the tokenizer will emit.*Example:*-[.dynamic-tabs]----[example.tab-pane#byname-tokenizer-lowercase]+[tabs#tokenizer-lowercase]+======+With name::++====-[.tab-label]*With name*[source,xml]----<analyzer>@@ -346,9 +354,10 @@ Maximum token length the tokenizer will emit.</analyzer>----====-[example.tab-pane#byclass-tokenizer-lowercase]++With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<analyzer>@@ -356,7 +365,7 @@ Maximum token length the tokenizer will emit.</analyzer>----====---+======*In:* "I just \*LOVE* my iPhone!"@@ -395,11 +404,12 @@ Note that this tokenizer operates over the whole field.It does not break the field at whitespace.As a result, the space character is included in the encoding.-[.dynamic-tabs]----[example.tab-pane#byname-tokenizer-ngram]+[tabs#tokenizer-ngram]+======++With name::++====-[.tab-label]*With name*[source,xml]----<analyzer>@@ -407,9 +417,10 @@ As a result, the space character is included in the encoding.</analyzer>----====-[example.tab-pane#byclass-tokenizer-ngram]++With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<analyzer>@@ -417,7 +428,7 @@ As a result, the space character is included in the encoding.</analyzer>----====---+======*In:* "hey man"@@ -427,11 +438,11 @@ As a result, the space character is included in the encoding.With an n-gram size range of 4 to 5:-[.dynamic-tabs]----[example.tab-pane#byname-tokenizer-ngram-args]+[tabs#tokenizer-ngram-args]+======+With name::++====-[.tab-label]*With name*[source,xml]----<analyzer>@@ -439,9 +450,10 @@ With an n-gram size range of 4 to 5:</analyzer>----====-[example.tab-pane#byclass-tokenizer-ngram-args]++With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<analyzer>@@ -449,7 +461,7 @@ With an n-gram size range of 4 to 5:</analyzer>----====---+======*In:* "bicycle"@@ -485,11 +497,11 @@ The maximum n-gram size, must be >= `minGramSize`.Default behavior (min and max default to 1):-[.dynamic-tabs]----[example.tab-pane#byname-tokenizer-edgengram]+[tabs#tokenizer-edgengram]+======+With name::++====-[.tab-label]*With name*[source,xml]----<analyzer>@@ -497,9 +509,10 @@ Default behavior (min and max default to 1):</analyzer>----====-[example.tab-pane#byclass-tokenizer-edgengram]++With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<analyzer>@@ -507,7 +520,7 @@ Default behavior (min and max default to 1):</analyzer>----====---+======*In:* "babaloo"@@ -517,11 +530,11 @@ Default behavior (min and max default to 1):Edge n-gram range of 2 to 5-[.dynamic-tabs]----[example.tab-pane#byname-tokenizer-edgengram-args]+[tabs#tokenizer-edgengram-args]+======+With name::++====-[.tab-label]*With name*[source,xml]----<analyzer>@@ -529,9 +542,10 @@ Edge n-gram range of 2 to 5</analyzer>----====-[example.tab-pane#byclass-tokenizer-edgengram-args]++With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<analyzer>@@ -539,7 +553,7 @@ Edge n-gram range of 2 to 5</analyzer>----====---+======*In:* "babaloo"@@ -589,11 +603,11 @@ If `true`, Myanmar text would undergo dictionary-based segmentation, otherwise i*Example:*-[.dynamic-tabs]----[example.tab-pane#byname-tokenizer-icu]+[tabs#tokenizer-icu]+======+With name::++====-[.tab-label]*With name*[source,xml]----<analyzer>@@ -602,9 +616,10 @@ If `true`, Myanmar text would undergo dictionary-based segmentation, otherwise i</analyzer>----====-[example.tab-pane#byclass-tokenizer-icu]++With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<analyzer>@@ -613,13 +628,13 @@ If `true`, Myanmar text would undergo dictionary-based segmentation, otherwise i</analyzer>----====---+======-[.dynamic-tabs]----[example.tab-pane#byname-tokenizer-icu-rule]+[tabs#tokenizer-icu-rule]+======+With name::++====-[.tab-label]*With name*[source,xml]----<analyzer>@@ -628,9 +643,10 @@ If `true`, Myanmar text would undergo dictionary-based segmentation, otherwise i</analyzer>----====-[example.tab-pane#byclass-tokenizer-icu-rule]++With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<analyzer>@@ -639,7 +655,7 @@ If `true`, Myanmar text would undergo dictionary-based segmentation, otherwise i</analyzer>----====---+======[IMPORTANT]====@@ -698,11 +714,11 @@ Number of leftmost (or rightmost, if reverse=true) path elements to drop from ea*Example:*Default behavior-[.dynamic-tabs]----[example.tab-pane#byname-tokenizer-pathhierarchy]+[tabs#tokenizer-pathhierarchy]+======+With name::++====-[.tab-label]*With name*[source,xml]----<fieldType name="text_path" class="solr.TextField" positionIncrementGap="100">@@ -712,9 +728,10 @@ Default behavior</fieldType>----====-[example.tab-pane#byclass-tokenizer-pathhierarchy]++With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<fieldType name="text_path" class="solr.TextField" positionIncrementGap="100">@@ -724,7 +741,7 @@ Default behavior</fieldType>----====---+======*In:* "c:\usr\local\apache"@@ -733,11 +750,11 @@ Default behavior*Example:*Reverse order-[.dynamic-tabs]----[example.tab-pane#byname-tokenizer-pathhierarchy-reversed]+[tabs#tokenizer-pathhierarchy-reversed]+======+With name::++====-[.tab-label]*With name*[source,xml]----<fieldType name="text_path" class="solr.TextField" positionIncrementGap="100">@@ -747,9 +764,10 @@ Reverse order</fieldType>----====-[example.tab-pane#byclass-tokenizer-pathhierarchy-reversed]++With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<fieldType name="text_path" class="solr.TextField" positionIncrementGap="100">@@ -759,7 +777,7 @@ Reverse order</fieldType>----====---+======*In:* "www.site.co.uk"@@ -802,11 +820,11 @@ Group zero refers to the entire regex, groups greater than zero refer to parenthA comma separated list.Tokens are separated by a sequence of zero or more spaces, a comma, and zero or more spaces.-[.dynamic-tabs]----[example.tab-pane#byname-tokenizer-pattern]+[tabs#tokenizer-pattern]+======+With name::++====-[.tab-label]*With name*[source,xml]----<analyzer>@@ -814,9 +832,10 @@ Tokens are separated by a sequence of zero or more spaces, a comma, and zero or</analyzer>----====-[example.tab-pane#byclass-tokenizer-pattern]++With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<analyzer>@@ -824,7 +843,7 @@ Tokens are separated by a sequence of zero or more spaces, a comma, and zero or</analyzer>----====---+======*In:* "fee,fie, foe , fum, foo"@@ -835,11 +854,11 @@ Tokens are separated by a sequence of zero or more spaces, a comma, and zero orExtract simple, capitalized words.A sequence of at least one capital letter followed by zero or more letters of either case is extracted as a token.-[.dynamic-tabs]----[example.tab-pane#byname-tokenizer-pattern-words]+[tabs#tokenizer-pattern-words]+======+With name::++====-[.tab-label]*With name*[source,xml]----<analyzer>@@ -847,9 +866,10 @@ A sequence of at least one capital letter followed by zero or more letters of ei</analyzer>----====-[example.tab-pane#byclass-tokenizer-pattern-words]++With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<analyzer>@@ -857,7 +877,7 @@ A sequence of at least one capital letter followed by zero or more letters of ei</analyzer>----====---+======*In:* "Hello. My name is Inigo Montoya. You killed my father. Prepare to die."@@ -870,11 +890,11 @@ Part numbers must be all numeric digits, with an optional hyphen.Regex capture groups are numbered by counting left parenthesis from left to right.Group 3 is the subexpression "[0-9-]+", which matches one or more digits or hyphens.-[.dynamic-tabs]----[example.tab-pane#byname-tokenizer-pattern-sku]+[tabs#tokenizer-pattern-sku]+======+With name::++====-[.tab-label]*With name*[source,xml]----<analyzer>@@ -882,9 +902,10 @@ Group 3 is the subexpression "[0-9-]+", which matches one or more digits or hyph</analyzer>----====-[example.tab-pane#byclass-tokenizer-pattern-sku]++With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<analyzer>@@ -892,7 +913,7 @@ Group 3 is the subexpression "[0-9-]+", which matches one or more digits or hyph</analyzer>----====---+======*In:* "SKU: 1234, Part Number 5678, Part: 126-987"@@ -931,11 +952,11 @@ The limit on total state count for the determined automaton computed from the reTo match tokens delimited by simple whitespace characters:-[.dynamic-tabs]----[example.tab-pane#byname-tokenizer-simplepattern]+[tabs#tokenizer-simplepattern]+======+With name::++====-[.tab-label]*With name*[source,xml]----<analyzer>@@ -943,9 +964,10 @@ To match tokens delimited by simple whitespace characters:</analyzer>----====-[example.tab-pane#byclass-tokenizer-simplepattern]++With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<analyzer>@@ -953,7 +975,7 @@ To match tokens delimited by simple whitespace characters:</analyzer>----====---+======== Simplified Regular Expression Pattern Splitting Tokenizer@@ -988,11 +1010,11 @@ The limit on total state count for the determined automaton computed from the reTo match tokens delimited by simple whitespace characters:-[.dynamic-tabs]----[example.tab-pane#byname-tokenizer-simplepatternsplit]+[tabs#tokenizer-simplepattern-split]+======+With name::++====-[.tab-label]*With name*[source,xml]----<analyzer>@@ -1000,9 +1022,10 @@ To match tokens delimited by simple whitespace characters:</analyzer>----====-[example.tab-pane#byclass-tokenizer-simplepatternsplit]++With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<analyzer>@@ -1010,7 +1033,7 @@ To match tokens delimited by simple whitespace characters:</analyzer>----====---+======== UAX29 URL Email Tokenizer@@ -1044,11 +1067,11 @@ Solr ignores tokens that exceed the number of characters specified by `maxTokenL*Example:*-[.dynamic-tabs]----[example.tab-pane#byname-tokenizer-uax29urlemail]+[tabs#tokenizer-uax29urlemail]+======+With name::++====-[.tab-label]*With name*[source,xml]----<analyzer>@@ -1056,9 +1079,10 @@ Solr ignores tokens that exceed the number of characters specified by `maxTokenL</analyzer>----====-[example.tab-pane#byclass-tokenizer-uax29urlemail]++With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<analyzer>@@ -1066,7 +1090,7 @@ Solr ignores tokens that exceed the number of characters specified by `maxTokenL</analyzer>----====---+======*In:* "Visit http://accarol.com/contact.htm?from=external&a=10 or e-mail [email protected]"@@ -1105,11 +1129,11 @@ Maximum token length the tokenizer will emit.*Example:*-[.dynamic-tabs]----[example.tab-pane#byname-tokenizer-whitespace]+[tabs#tokenizer-whitespace]+======+With name::++====-[.tab-label]*With name*[source,xml]----<analyzer>@@ -1117,9 +1141,10 @@ Maximum token length the tokenizer will emit.</analyzer>----====-[example.tab-pane#byclass-tokenizer-whitespace]++With class name (legacy)::++====-[.tab-label]*With class name (legacy)*[source,xml]----<analyzer>@@ -1127,7 +1152,7 @@ Maximum token length the tokenizer will emit.</analyzer>----====---+======*In:* "To be, or what?"diff --git a/solr/solr-ref-guide/modules/indexing-guide/pages/transforming-and-indexing-custom-json.adoc b/solr/solr-ref-guide/modules/indexing-guide/pages/transforming-and-indexing-custom-json.adocindex 766ee74f5c2..f3fdd6f2153 100644--- a/solr/solr-ref-guide/modules/indexing-guide/pages/transforming-and-indexing-custom-json.adoc+++ b/solr/solr-ref-guide/modules/indexing-guide/pages/transforming-and-indexing-custom-json.adoc@@ -1,4 +1,5 @@= Transforming and Indexing Custom JSON+:tabs-sync-option:// Licensed to the Apache Software Foundation (ASF) under one// or more contributor license agreements. See the NOTICE file// distributed with this work for additional information@@ -99,11 +100,11 @@ Nothing will be indexed.For example, if we have a JSON file that includes two documents, we could define an update request like this:-[.dynamic-tabs]----[example.tab-pane#v1transform]+[tabs#transform]+======+V1 API::++====-[.tab-label]*V1 API*[source,bash]----curl 'http://localhost:8983/solr/techproducts/update/json/docs'\@@ -133,9 +134,9 @@ curl 'http://localhost:8983/solr/techproducts/update/json/docs'\----====-[example.tab-pane#v2transform]+V2 API User-Managed / Single-Node Solr::++====-[.tab-label]*V2 API User-Managed / Single-Node Solr*[source,bash]----curl 'http://localhost:8983/api/cores/techproducts/update/json/docs'\@@ -165,9 +166,9 @@ curl 'http://localhost:8983/api/cores/techproducts/update/json/docs'\----====-[example.tab-pane#v2transformcloud]+V2 API SolrCloud::++====-[.tab-label]*V2 API SolrCloud*[source,bash]----curl 'http://localhost:8983/api/collections/techproducts/update/json/docs'\@@ -196,7 +197,7 @@ curl 'http://localhost:8983/api/collections/techproducts/update/json/docs'\}'----====---+======With this request, we have defined that "exams" contains multiple documents.In addition, we have mapped several fields from the input document to Solr fields.@@ -226,11 +227,11 @@ When the update request is complete, the following two documents will be added tIn the prior example, all of the fields we wanted to use in Solr had the same names as they did in the input JSON.When that is the case, we can simplify the request by only specifying the `json-path` portion of the `f` parameter, as in this example:-[.dynamic-tabs]----[example.tab-pane#v1simpler]+[tabs#simpler]+======+V1 API::++====-[.tab-label]*V1 API*[source,bash]----curl 'http://localhost:8983/solr/techproducts/update/json/docs'\@@ -260,9 +261,9 @@ curl 'http://localhost:8983/solr/techproducts/update/json/docs'\----====-[example.tab-pane#v2simpler]+V2 API User-Managed / Single-Node Solr::++====-[.tab-label]*V2 API User-Managed / Single-Node Solr*[source,bash]----curl 'http://localhost:8983/api/cores/techproducts/update/json/docs'\@@ -292,9 +293,9 @@ curl 'http://localhost:8983/api/cores/techproducts/update/json/docs'\----====-[example.tab-pane#v2simplercloud]+V2 API SolrCloud::++====-[.tab-label]*V2 API SolrCloud*[source,bash]----curl 'http://localhost:8983/api/collections/techproducts/update/json/docs'\@@ -323,7 +324,7 @@ curl 'http://localhost:8983/api/collections/techproducts/update/json/docs'\}'----====---+======In this example, we simply named the field paths (such as `/exams/test`).Solr will automatically attempt to add the content of the field from the JSON input to the index in a field with the same name.@@ -342,11 +343,11 @@ You can store and re-use parameters with Solr's xref:configuration-guide:requestSay we wanted to define parameters to split documents at the `exams` field, and map several other fields.We could make an API request such as:-[.dynamic-tabs]----[example.tab-pane#v1splitparams]+[tabs#splitparams]+======+V1 API::++====-[.tab-label]*V1 API*[source,bash]----curl http://localhost:8983/solr/techproducts/config/params -H 'Content-type:application/json' -d '{@@ -358,9 +359,9 @@ We could make an API request such as:----====-[example.tab-pane#v2splitparams]+V2 API User-Managed / Single-Node Solr::++====-[.tab-label]*V2 API User-Managed / Single-Node Solr*[source,bash]----curl http://localhost:8983/api/cores/techproducts/config/params -H 'Content-type:application/json' -d '{@@ -372,9 +373,9 @@ curl http://localhost:8983/api/cores/techproducts/config/params -H 'Content-type----====-[example.tab-pane#v2splitparamscloud]+V2 API SolrCloud::++====-[.tab-label]*V2 API SolrCloud*[source,bash]----curl http://localhost:8983/api/collections/techproducts/config/params -H 'Content-type:application/json' -d '{@@ -385,15 +386,15 @@ curl http://localhost:8983/api/collections/techproducts/config/params -H 'Conten}}}'----====---+======When we send the documents, we'd use the `useParams` parameter with the name of the parameter set we defined:-[.dynamic-tabs]----[example.tab-pane#v1useparams]+[tabs#useparams]+======+V1 API::++====-[.tab-label]*V1 API*[source,bash]----curl 'http://localhost:8983/solr/techproducts/update/json/docs?useParams=my_params' -H 'Content-type:application/json' -d '{@@ -415,9 +416,9 @@ curl 'http://localhost:8983/solr/techproducts/update/json/docs?useParams=my_para----====-[example.tab-pane#v2useparams]+V2 API User-Managed / Single-Node Solr::++====-[.tab-label]*V2 API User-Managed / Single-Node Solr*[source,bash]----curl 'http://localhost:8983/api/cores/techproducts/update/json?useParams=my_params' -H 'Content-type:application/json' -d '{@@ -439,9 +440,9 @@ curl 'http://localhost:8983/api/cores/techproducts/update/json?useParams=my_para----====-[example.tab-pane#v2useparamscloud]+V2 API SolrCloud::++====-[.tab-label]*V2 API SolrCloud*[source,bash]----curl 'http://localhost:8983/api/collections/techproducts/update/json?useParams=my_params' -H 'Content-type:application/json' -d '{@@ -462,7 +463,7 @@ curl 'http://localhost:8983/api/collections/techproducts/update/json?useParams=m}'----====---+======== Using Wildcards for Field Names@@ -483,11 +484,11 @@ This is the default behavior if no `f` path mappings are specified.With wildcards we can further simplify our previous example as follows:-[.dynamic-tabs]----[example.tab-pane#v1wildcards]+[tabs#wildcards]+======+V1 API::++====-[.tab-label]*V1 API*[source,bash]----curl 'http://localhost:8983/solr/techproducts/update/json/docs'\@@ -512,9 +513,9 @@ curl 'http://localhost:8983/solr/techproducts/update/json/docs'\----====-[example.tab-pane#v2wildcards]+V2 API User-Managed / Single-Node Solr::++====-[.tab-label]*V2 API User-Managed / Single-Node Solr*[source,bash]----curl 'http://localhost:8983/api/cores/techproducts/update/json'\@@ -539,9 +540,9 @@ curl 'http://localhost:8983/api/cores/techproducts/update/json'\----====-[example.tab-pane#v2wildcardscloud]+V2 API SolrCloud::++====-[.tab-label]*V2 API SolrCloud*[source,bash]----curl 'http://localhost:8983/api/collections/techproducts/update/json'\@@ -565,18 +566,18 @@ curl 'http://localhost:8983/api/collections/techproducts/update/json'\}'----====---+======Because we want the fields to be indexed with the field names as they are found in the JSON input, the double wildcard in `f=/**` will map all fields and their descendants to the same fields in Solr.It is also possible to send all the values to a single field and do a full text search on that.This is a good option to blindly index and query JSON documents without worrying about fields and schema.-[.dynamic-tabs]----[example.tab-pane#v1wildcardtxt]+[tabs#wildcardtxt]+======+V1 API::++====-[.tab-label]*V1 API*[source,bash]----curl 'http://localhost:8983/solr/techproducts/update/json/docs'\@@ -601,9 +602,9 @@ curl 'http://localhost:8983/solr/techproducts/update/json/docs'\----====-[example.tab-pane#v2wildcardtxt]+V2 API User-Managed / Single-Node Solr::++====-[.tab-label]*V2 API User-Managed / Single-Node Solr*[source,bash]----curl 'http://localhost:8983/api/cores/techproducts/update/json'\@@ -628,9 +629,9 @@ curl 'http://localhost:8983/api/cores/techproducts/update/json'\----====-[example.tab-pane#v2wildcardtxtcloud]+V2 API SolrCloud::++====-[.tab-label]*V2 API SolrCloud*[source,bash]----curl 'http://localhost:8983/api/collections/techproducts/update/json'\@@ -654,7 +655,7 @@ curl 'http://localhost:8983/api/collections/techproducts/update/json'\}'----====---+======In the above example, we've said all of the fields should be added to a field in Solr named 'txt'.This will add multiple fields to a single field, so whatever field you choose should be multi-valued.@@ -662,11 +663,11 @@ This will add multiple fields to a single field, so whatever field you choose shThe default behavior is to use the fully qualified name (FQN) of the node.So, if we don't define any field mappings, like this:-[.dynamic-tabs]----[example.tab-pane#v1wildcardfqn]+[tabs#wildcardfqn]+======+V1 API::++====-[.tab-label]*V1 API*[source,bash]----curl 'http://localhost:8983/solr/techproducts/update/json/docs?split=/exams'\@@ -689,9 +690,9 @@ curl 'http://localhost:8983/solr/techproducts/update/json/docs?split=/exams'\----====-[example.tab-pane#v2wildcardfqn]+V2 API User-Managed / Single-Node Solr::++====-[.tab-label]*V2 API User-Managed / Single-Node Solr*[source,bash]----curl 'http://localhost:8983/api/cores/techproducts/update/json?split=/exams'\@@ -714,9 +715,9 @@ curl 'http://localhost:8983/api/cores/techproducts/update/json?split=/exams'\----====-[example.tab-pane#v2wildcardfqncloud]+V2 API SolrCloud::++====-[.tab-label]*V2 API SolrCloud*[source,bash]----curl 'http://localhost:8983/api/collections/techproducts/update/json?split=/exams'\@@ -738,7 +739,7 @@ curl 'http://localhost:8983/api/collections/techproducts/update/json?split=/exam}'----====---+======The indexed documents would be added to the index with fields that look like this:@@ -766,11 +767,11 @@ This functionality supports documents in the http://jsonlines.org/[JSON Lines] fFor example:-[.dynamic-tabs]----[example.tab-pane#v1multidocs]+[tabs#multidocs]+======+V1 API::++====-[.tab-label]*V1 API*[source,bash]----curl 'http://localhost:8983/solr/techproducts/update/json/docs' -H 'Content-type:application/json' -d '@@ -779,9 +780,9 @@ curl 'http://localhost:8983/solr/techproducts/update/json/docs' -H 'Content-type----====-[example.tab-pane#v2multidocs]+V2 API User-Managed / Single-Node Solr::++====-[.tab-label]*V2 API User-Managed / Single-Node Solr*[source,bash]----curl 'http://localhost:8983/api/collections/techproducts/update/json' -H 'Content-type:application/json' -d '@@ -790,9 +791,9 @@ curl 'http://localhost:8983/api/collections/techproducts/update/json' -H 'Conten----====-[example.tab-pane#v2multidocscloud]+V2 API SolrCloud::++====-[.tab-label]*V2 API SolrCloud*[source,bash]----curl 'http://localhost:8983/api/collections/techproducts/update/json' -H 'Content-type:application/json' -d '@@ -800,15 +801,15 @@ curl 'http://localhost:8983/api/collections/techproducts/update/json' -H 'Conten{ "first":"Steve", "last":"Woz", "grade":1, "subject":"Political Science", "test":"term1", "marks":86}'----====---+======Or even an array of documents, as in this example:-[.dynamic-tabs]----[example.tab-pane#v1array]+[tabs#array]+======+V1 API::++====-[.tab-label]*V1 API*[source,bash]----curl 'http://localhost:8983/solr/techproducts/update/json/docs' -H 'Content-type:application/json' -d '[@@ -817,9 +818,9 @@ curl 'http://localhost:8983/solr/techproducts/update/json/docs' -H 'Content-type----====-[example.tab-pane#v2array]+V2 API User-Managed / Single-Node Solr::++====-[.tab-label]*V2 API User-Managed / Single-Node Solr*[source,bash]----curl 'http://localhost:8983/api/cores/techproducts/update/json' -H 'Content-type:application/json' -d '[@@ -828,9 +829,9 @@ curl 'http://localhost:8983/api/cores/techproducts/update/json' -H 'Content-type----====-[example.tab-pane#v2arraycloud]+V2 API SolrCloud::++====-[.tab-label]*V2 API SolrCloud*[source,bash]----curl 'http://localhost:8983/api/collections/techproducts/update/json' -H 'Content-type:application/json' -d '[@@ -838,7 +839,7 @@ curl 'http://localhost:8983/api/collections/techproducts/update/json' -H 'Conten{"first":"Steve", "last":"Woz", "grade":1, "subject":"Calculus", "test":"term1", "marks":86}]'----====---+======== Tips for Custom JSON Indexing@@ -876,11 +877,11 @@ If there is a value for the uniqueKey it is stored and if no value could be obtaAlternately, use the Request Parameters feature to set these parameters, as shown earlier in the section <<Reusing Parameters in Multiple Requests>>.-[.dynamic-tabs]----[example.tab-pane#v1jsondefault]+[tabs#jsondefault]+======+V1 API::++====-[.tab-label]*V1 API*[source,bash]----curl http://localhost:8983/solr/techproducts/config/params -H 'Content-type:application/json' -d '{@@ -893,9 +894,9 @@ Alternately, use the Request Parameters feature to set these parameters, as show----====-[example.tab-pane#v2jsondefault]+V2 API User-Managed / Single-Node Solr::++====-[.tab-label]*V2 API User-Managed / Single-Node Solr*[source,bash]----curl http://localhost:8983/api/cores/techproducts/config/params -H 'Content-type:application/json' -d '{@@ -908,9 +909,9 @@ Alternately, use the Request Parameters feature to set these parameters, as show----====-[example.tab-pane#v2jsondefaultcloud]+V2 API SolrCloud::++====-[.tab-label]*V2 API SolrCloud*[source,bash]----curl http://localhost:8983/api/collections/techproducts/config/params -H 'Content-type:application/json' -d '{@@ -922,6 +923,6 @@ Alternately, use the Request Parameters feature to set these parameters, as show}}}'----====---+======To use these parameters, send the parameter `useParams=full_txt` with each request.diff --git a/solr/solr-ref-guide/modules/query-guide/pages/dense-vector-search.adoc b/solr/solr-ref-guide/modules/query-guide/pages/dense-vector-search.adocindex a165015837a..63f5b016a04 100644--- a/solr/solr-ref-guide/modules/query-guide/pages/dense-vector-search.adoc+++ b/solr/solr-ref-guide/modules/query-guide/pages/dense-vector-search.adoc@@ -1,4 +1,5 @@= Dense Vector Search+:tabs-sync-option:// Licensed to the Apache Software Foundation (ASF) under one// or more contributor license agreements. See the NOTICE file// distributed with this work for additional information@@ -177,11 +178,11 @@ currently multivalue is not supportedHere's how a `DenseVectorField` should be indexed:-[.dynamic-tabs]----[example.tab-pane#json]+[tabs#densevectorfield-index]+======+JSON::++====-[.tab-label]*JSON*[source,json]----[{ "id": "1",@@ -194,9 +195,9 @@ Here's how a `DenseVectorField` should be indexed:----====-[example.tab-pane#xml]+XML::++====-[.tab-label]*XML*[source,xml]----<add>@@ -218,9 +219,9 @@ Here's how a `DenseVectorField` should be indexed:----====-[example.tab-pane#solrj]+SolrJ::++====-[.tab-label]*SolrJ*[source,java,indent=0]----final SolrClient client = getSolrClient();@@ -237,7 +238,7 @@ d2.setField("vector", Arrays.asList(1.5f, 5.5f, 6.7f, 65.1f));client.add(Arrays.asList(d1, d2));----====---+======== Query Timediff --git a/solr/solr-ref-guide/modules/query-guide/pages/json-facet-api.adoc b/solr/solr-ref-guide/modules/query-guide/pages/json-facet-api.adocindex 988e6a42f82..bc73fb5314d 100644--- a/solr/solr-ref-guide/modules/query-guide/pages/json-facet-api.adoc+++ b/solr/solr-ref-guide/modules/query-guide/pages/json-facet-api.adoc@@ -1,5 +1,6 @@= JSON Facet API:page-children: json-faceting-domain-changes+:tabs-sync-option:// Licensed to the Apache Software Foundation (ASF) under one// or more contributor license agreements. See the NOTICE file// distributed with this work for additional information@@ -40,11 +41,11 @@ There are two main types of facets:Here's an example of a bucketing facet, that partitions documents into bucket based on the `cat` field (short for category), and returns the top 3 buckets:-[.dynamic-tabs]----[example.tab-pane#curljsonsimpletermsfacet]+[tabs#json-simple-terms-facet]+======+curl::++====-[.tab-label]*curl*[source,bash]----curl http://localhost:8983/solr/techproducts/query -d '@@ -61,21 +62,20 @@ curl http://localhost:8983/solr/techproducts/query -d '----====-[example.tab-pane#solrjjsonsimpletermsfacet]+SolrJ::++====-[.tab-label]*SolrJ*-[source,java,indent=0]----include::example$JsonRequestApiTest.java[tag=solrj-json-simple-terms-facet]----====---+======The response below shows us that 32 documents match the default root domain.Twelve documents have `cat:electronics`, 4 documents have `cat:currency`, etc.-[source,java]+[source,json]----[...]"facets":{@@ -101,11 +101,11 @@ Stat (also called `aggregation` or `analytic`) facets are useful for displayingFor example, stat facets can be used to provide context to users on an e-commerce site looking for memory.The example below computes the average price (and other statistics) and would allow a user to gauge whether the memory stick in their cart is a good price.-[.dynamic-tabs]----[example.tab-pane#curl-json-metrics-facet-1]+[tabs#json-metrics-facet-1]+======+curl::++====-[.tab-label]*curl*[source,bash]----curl http://localhost:8983/solr/techproducts/query -d '@@ -119,16 +119,15 @@ json.facet={----====-[example.tab-pane#solrj-json-metrics-facet-1]+SolrJ::++====-[.tab-label]*SolrJ*-[source,java,indent=0]----include::example$JsonRequestApiTest.java[tag=solrj-json-metrics-facet-1]----====---+======The response to the facet request above will start with documents matching the root domain (docs containing "memory" with inStock:true) followed by the requested statistics in a `facets` block:@@ -155,11 +154,11 @@ Each of these facet-types are covered in detail below.A `terms` facet buckets the domain based on the unique values in a field.-[.dynamic-tabs]----[example.tab-pane#curl-json-terms-facet-2]+[tabs#json-terms-facet-2]+======+curl::++====-[.tab-label]*curl*[source,bash]----curl http://localhost:8983/solr/techproducts/query -d '@@ -176,16 +175,15 @@ curl http://localhost:8983/solr/techproducts/query -d '----====-[example.tab-pane#solrj-json-terms-facet-2]+SolrJ::++====-[.tab-label]*SolrJ*-[source,java,indent=0]----include::example$JsonRequestApiTest.java[tag=solrj-json-terms-facet-2]----====---+======[width="100%",cols="20%,90%",options="header",]|===@@ -232,11 +230,11 @@ This parameter indicates the facet algorithm to use:The query facet produces a single bucket of documents that match the domain as well as the specified query.-[.dynamic-tabs]----[example.tab-pane#curl-json-query-facet-simple]+[tabs#json-query-facet-simple]+======+curl::++====-[.tab-label]*curl*[source,bash]----curl http://localhost:8983/solr/techproducts/query -d '@@ -252,24 +250,23 @@ curl http://localhost:8983/solr/techproducts/query -d '----====-[example.tab-pane#solrj-json-query-facet-simple]+SolrJ::++====-[.tab-label]*SolrJ*-[source,java,indent=0]----include::example$JsonRequestApiTest.java[tag=solrj-json-query-facet-simple]----====---+======Users may also specify sub-facets (either "bucketing" facets or metrics):-[.dynamic-tabs]----[example.tab-pane#curl-json-query-facet-expanded]+[tabs#json-query-facet-expanded]+======+curl::++====-[.tab-label]*curl*[source,bash]----curl http://localhost:8983/solr/techproducts/query -d '@@ -288,20 +285,19 @@ curl http://localhost:8983/solr/techproducts/query -d '----====-[example.tab-pane#solrj-json-query-facet-expanded]+SolrJ::++====-[.tab-label]*SolrJ*-[source,java,indent=0]----include::example$JsonRequestApiTest.java[tag=solrj-json-query-facet-expanded]----====---+======Example response:-[source,java]+[source,json]----"high_popularity" : {"count" : 36,@@ -313,11 +309,11 @@ Example response:The range facet produces multiple buckets over a date or numeric field.-[.dynamic-tabs]----[example.tab-pane#curl-json-range-facet-simple]+[tabs#json-range-facet-simple]+======+curl::++====-[.tab-label]*curl*[source,bash]----curl http://localhost:8983/solr/techproducts/query -d '@@ -336,20 +332,19 @@ curl http://localhost:8983/solr/techproducts/query -d '----====-[example.tab-pane#solrj-json-range-facet-simple]+SolrJ::++====-[.tab-label]*SolrJ*-[source,java,indent=0]----include::example$JsonRequestApiTest.java[tag=solrj-json-range-facet-simple]----====---+======The output from the range facet above would look a bit like:-[source,java]+[source,json]----"prices":{"buckets":[@@ -512,11 +507,11 @@ For example `geom` here corresponds to `facet.heatmap.geom` in a facet.heatmap cNOTE: Unlike other facets that partition the domain into buckets, `heatmap` facets do not currently support <<Nested Facets>>.-[.dynamic-tabs]----[example.tab-pane#curl-json-heatmap-facet-1]+[tabs#json-heatmap-facet-1]+======+curl::++====-[.tab-label]*curl*[source,bash]----curl http://localhost:8983/solr/spatialdata/query -d '@@ -534,16 +529,15 @@ curl http://localhost:8983/solr/spatialdata/query -d '----====-[example.tab-pane#solrj-json-heatmap-facet-1]+SolrJ::++====-[.tab-label]*SolrJ*-[source,java,indent=0]----include::example$JsonRequestApiHeatmapFacetingTest.java[tag=solrj-json-heatmap-facet-1]----====---+======And the facet response will look like:[source,json]@@ -593,11 +587,11 @@ Numeric aggregation functions such as `avg` can be on any numeric field, or on aThe most common way of requesting an aggregation function is as a simple String containing the expression you wish to compute:-[.dynamic-tabs]----[example.tab-pane#curl-json-metrics-facet-simple]+[tabs#json-metrics-facet-simple]+======+curl::++====-[.tab-label]*curl*[source,bash]----curl http://localhost:8983/solr/techproducts/query -d '@@ -614,25 +608,24 @@ curl http://localhost:8983/solr/techproducts/query -d '----====-[example.tab-pane#solrj-json-metrics-facet-simple]+SolrJ::++====-[.tab-label]*SolrJ*-[source,java,indent=0]----include::example$JsonRequestApiTest.java[tag=solrj-json-metrics-facet-simple]----====---+======An expanded form allows for xref:local-params.adoc[] to be specified.These may be used explicitly by some specialized aggregations such as <<relatedness-options,`relatedness()`>>, but can also be used as parameter references to make aggregation expressions more readable, without needing to use (global) request parameters:-[.dynamic-tabs]----[example.tab-pane#curl-json-metrics-facet-expanded]+[tabs#json-metrics-facet-expanded]+======+curl::++====-[.tab-label]*curl*[source,bash]----curl http://localhost:8983/solr/techproducts/query -d '@@ -654,16 +647,15 @@ curl http://localhost:8983/solr/techproducts/query -d '----====-[example.tab-pane#solrj-json-metrics-facet-expanded]+SolrJ::++====-[.tab-label]*SolrJ*-[source,java,indent=0]----include::example$JsonRequestApiTest.java[tag=solrj-json-metrics-facet-expanded]----====---+======== Nested Facets@@ -678,11 +670,11 @@ Technically, every facet command is actually a sub-facet since we start off withLet's start off with a simple non-nested terms facet on the category field `cat`:-[.dynamic-tabs]----[example.tab-pane#curl-json-unnested-cat-facet]+[tabs#json-unnested-cat-facet]+======+curl::++====-[.tab-label]*curl*[source,bash]----curl http://localhost:8983/solr/techproducts/query -d '@@ -699,26 +691,25 @@ curl http://localhost:8983/solr/techproducts/query -d '----====-[example.tab-pane#solrj-json-unnested-cat-facet]+SolrJ::++====-[.tab-label]*SolrJ*-[source,java,indent=0]----include::example$JsonRequestApiTest.java[tag=solrj-json-simple-terms-facet]----====---+======The response for the facet above will show the top category and the number of documents that falls into each category bucket.Nested facets can be used to gather additional information about each bucket of documents.For example, using the nested facet below, we can find the top categories as well as who the leading manufacturer is in each category:-[.dynamic-tabs]----[example.tab-pane#curl-json-nested-cat-facet]+[tabs#json-nested-cat-facet]+======+curl::++====-[.tab-label]*curl*[source,bash]----curl http://localhost:8983/solr/techproducts/query -d '@@ -742,16 +733,15 @@ curl http://localhost:8983/solr/techproducts/query -d '----====-[example.tab-pane#solrj-json-nested-cat-facet]+SolrJ::++====-[.tab-label]*SolrJ*-[source,java,indent=0]----include::example$JsonRequestApiTest.java[tag=solrj-json-nested-cat-facet]----====---+======And the response will look something like:@@ -783,11 +773,11 @@ The default sort for a field or terms facet is by bucket count descending.We can optionally `sort` ascending or descending by any facet function that appears in each bucket.-[.dynamic-tabs]----[example.tab-pane#curl-json-nested-cat-facet-sorted]+[tabs#json-nested-cat-facet-sorted]+======+curl::++====-[.tab-label]*curl*[source,bash]----curl http://localhost:8983/solr/techproducts/query -d '@@ -808,35 +798,34 @@ curl http://localhost:8983/solr/techproducts/query -d '----====-[example.tab-pane#solrj-json-nested-cat-facet-sorted]+SolrJ::++====-[.tab-label]*SolrJ*-[source,java,indent=0]----include::example$JsonRequestApiTest.java[tag=solrj-json-nested-cat-facet-sorted]----====---+======In some situations the desired `sort` may be an aggregation function that is very costly to compute for every bucket.A `prelim_sort` option can be used to specify an approximation of the `sort`, for initially ranking the buckets to determine the top candidates (based on the `limit` and `overrequest`).Only after the top candidate buckets have been refined, will the actual `sort` be used.-[source,java]+[source,json]----{- categories:{- type : terms,- field : cat,- refine: true,- limit: 10,- overrequest: 100,- prelim_sort: "sales_rank desc",- sort : "prod_quality desc",- facet : {- prod_quality : "avg(div(prod(rating,sales_rank),prod(num_returns,price)))"- sales_rank : "sum(sales_rank)"+ "categories": {+ "type" : "terms",+ "field" : "cat",+ "refine": true,+ "limit": 10,+ "overrequest": 100,+ "prelim_sort": "sales_rank desc",+ "sort": "prod_quality desc",+ "facet": {+ "prod_quality": "avg(div(prod(rating,sales_rank),prod(num_returns,price)))"+ "sales_rank": "sum(sales_rank)"}}}@@ -887,14 +876,14 @@ Suppose we have products with multiple SKUs, and we want to count products for eWhen searching against a set of SKU documents, we can ask for a facet on color, with a nested statistic counting all the "blocks" -- aka: products:-[source,java]+[source,json]-----color: {- type: terms,- field: color,- limit: -1,- facet: {- productsCount: "uniqueBlock(_root_)"+"color": {+ "type": "terms",+ "field": "color",+ "limit": -1,+ "facet": {+ "productsCount": "uniqueBlock(_root_)"// or "uniqueBlock({!v=type:product})"}}@@ -902,12 +891,12 @@ color: {and get:-[source,java]+[source,json]-----color:{- buckets:[- { val:Blue, count:2, productsCount:2 },- { val:Red, count:2, productsCount:1 }+"color": {+ "buckets": [+ { "val": "Blue", "count": 2, "productsCount": 2 },+ { "val": "Red", "count": 2, "productsCount": 1 }]}----@@ -954,9 +943,10 @@ This heuristic is _not_ used to determine default behavior, particularly because[source,json]-----{ "type": "func",+{+ "type": "func","func": "relatedness($fore,$back)",- "min_popularity": 0.001,+ "min_popularity": 0.001}----diff --git a/solr/solr-ref-guide/modules/query-guide/pages/json-faceting-domain-changes.adoc b/solr/solr-ref-guide/modules/query-guide/pages/json-faceting-domain-changes.adocindex 6390db0914d..954cb50769d 100644--- a/solr/solr-ref-guide/modules/query-guide/pages/json-faceting-domain-changes.adoc+++ b/solr/solr-ref-guide/modules/query-guide/pages/json-faceting-domain-changes.adoc@@ -1,4 +1,5 @@= JSON Faceting Domain Changes+:tabs-sync-option:// Licensed to the Apache Software Foundation (ASF) under one// or more contributor license agreements. See the NOTICE file// distributed with this work for additional information@@ -35,11 +36,11 @@ A `\*:*` query facet with a `domain` change can be used to group multiple sub-faThe simplest example of a domain change is to specify an additional filter which will be applied to the existing domain.This can be done via the `filter` keyword in the `domain` block of the facet.-[.dynamic-tabs]----[example.tab-pane#curl-json-facet-filtered-domain]+[tabs#json-facet-filtered-domain]+======+curl::++====-[.tab-label]*curl*[source,bash]----curl http://localhost:8983/solr/techproducts/query -d '@@ -59,16 +60,15 @@ curl http://localhost:8983/solr/techproducts/query -d '----====-[example.tab-pane#solrj-json-facet-filtered-domain]+SolrJ::++====-[.tab-label]*SolrJ*-[source,java,indent=0]----include::example$JsonRequestApiTest.java[tag=solrj-json-facet-filtered-domain]----====---+======The value of `filter` can be a single query to treat as a filter, or a JSON list of filter queries.Each query can be:@@ -126,11 +126,11 @@ Domains can also be expanded by using the `excludeTags` keyword to discard or igThis is used in the example below to show the top two manufacturers matching a search.The search results match the filter `manu_id_s:apple`, but the computed facet discards this filter and operates a domain widened by discarding the `manu_id_s` filter.-[.dynamic-tabs]----[example.tab-pane#curl-json-facet-excludetags-domain]+[tabs#json-facet-excludetags-domain]+======+curl::++====-[.tab-label]*curl*[source,bash]----curl http://localhost:8983/solr/techproducts/query -d '@@ -150,16 +150,15 @@ curl http://localhost:8983/solr/techproducts/query -d '----====-[example.tab-pane#solrj-json-facet-excludetags-domain]+SolrJ::++====-[.tab-label]*SolrJ*-[source,java,indent=0]----include::example$JsonRequestApiTest.java[tag=solrj-json-facet-excludetags-domain]----====---+======The value of `excludeTags` can be a single string tag, an array of string tags, or comma-separated tags in the single string.@@ -175,11 +174,11 @@ But it can also be useful on nested facets when building xref:json-facet-api.adoExample:-[.dynamic-tabs]----[example.tab-pane#curl-json-facet-query-domain]+[tabs#json-facet-query-domain]+======+curl::++====-[.tab-label]*curl*[source,bash]----curl http://localhost:8983/solr/techproducts/query -d '@@ -197,16 +196,15 @@ curl http://localhost:8983/solr/techproducts/query -d '----====-[example.tab-pane#solrj-json-facet-query-domain]+SolrJ::++====-[.tab-label]*SolrJ*-[source,java,indent=0]----include::example$JsonRequestApiTest.java[tag=solrj-json-facet-query-domain]----====---+======The value of `query` can be a single query, or a JSON list of queries.Each query can be:diff --git a/solr/solr-ref-guide/modules/query-guide/pages/json-query-dsl.adoc b/solr/solr-ref-guide/modules/query-guide/pages/json-query-dsl.adocindex 3f6b9f2572b..104fba52eec 100644--- a/solr/solr-ref-guide/modules/query-guide/pages/json-query-dsl.adoc+++ b/solr/solr-ref-guide/modules/query-guide/pages/json-query-dsl.adoc@@ -1,4 +1,5 @@= JSON Query DSL+:tabs-sync-option:// Licensed to the Apache Software Foundation (ASF) under one// or more contributor license agreements. See the NOTICE file// distributed with this work for additional information@@ -40,33 +41,33 @@ Each snippet represents the same basic search: the term `iPod` in a field calledUsing the standard query API, with a simple query string:-[.dynamic-tabs]----[example.tab-pane#curl-ipod-query-basic]+[tabs#ipod-query-basic]+======+curl::++====-[.tab-label]*curl*[source,bash]----curl -X GET "http://localhost:8983/solr/techproducts/query?q=name:iPod"----====-[example.tab-pane#solrj-ipod-query-basic]+SolrJ::++====-[.tab-label]*SolrJ*[source,java,indent=0]----include::example$JsonRequestApiTest.java[tag=solrj-ipod-query-basic]----====---+======Using the JSON Request API, with a simple query string:-[.dynamic-tabs]----[example.tab-pane#curl-ipod-query-dsl-1]+[tabs#ipod-query-dsl-1]+======+curl::++====-[.tab-label]*curl*[source,bash]----curl -X POST http://localhost:8983/solr/techproducts/query -d '@@ -75,23 +76,24 @@ curl -X POST http://localhost:8983/solr/techproducts/query -d '}'----====-[example.tab-pane#solrj-ipod-query-dsl-1]++SolrJ::++====-[.tab-label]*SolrJ*[source,java,indent=0]----include::example$JsonRequestApiTest.java[tag=solrj-ipod-query-dsl-1]----====---+======Using the JSON Request API, with a local-params string:-[.dynamic-tabs]----[example.tab-pane#curl-ipod-query-dsl-2]+[tabs#ipod-query-dsl-2]+======+curl::++====-[.tab-label]*curl*[source,bash]----curl -X POST http://localhost:8983/solr/techproducts/query -d '@@ -100,23 +102,24 @@ curl -X POST http://localhost:8983/solr/techproducts/query -d '}'----====-[example.tab-pane#solrj-ipod-query-dsl-2]++SolrJ::++====-[.tab-label]*SolrJ*[source,java,indent=0]----include::example$JsonRequestApiTest.java[tag=solrj-ipod-query-dsl-2]----====---+======Using the JSON Request API, with a fully expanded JSON object:-[.dynamic-tabs]----[example.tab-pane#curl-ipod-query-dsl-3]+[tabs#ipod-query-dsl-3]+======+curl::++====-[.tab-label]*curl*[source,bash]----curl -X POST http://localhost:8983/solr/techproducts/query -d '@@ -130,15 +133,16 @@ curl -X POST http://localhost:8983/solr/techproducts/query -d '}'----====-[example.tab-pane#solrj-ipod-query-dsl-3]++SolrJ::++====-[.tab-label]*SolrJ*[source,java,indent=0]----include::example$JsonRequestApiTest.java[tag=solrj-ipod-query-dsl-3]----====---+======== Nested QueriesMany of Solr's query parsers allow queries to be nested within one another.@@ -150,34 +154,35 @@ As an example, consider the three requests below, which wrap a simple query (theUsing the standard query API:-[.dynamic-tabs]----[example.tab-pane#curl-ipod-query-boosted-basic]+[tabs#ipod-query-boosted-basic]+======+curl::++====-[.tab-label]*curl*[source,bash]----curl -X GET "http://localhost:8983/solr/techproducts/query?q={!boost b=log(popularity) v=\'{!lucene df=name}iPod\'}"----====-[example.tab-pane#solrj-ipod-query-boosted-basic]++SolrJ::++====-[.tab-label]*SolrJ*[source,java,indent=0]----include::example$JsonRequestApiTest.java[tag=solrj-ipod-query-boosted-basic]----====---+======Using the JSON Request API, with a mix of fully-expanded and local-params queries.As you can see, the special key `v` is replaced with the key `query`:-[.dynamic-tabs]----[example.tab-pane#curl-ipod-query-boosted-dsl-1]+[tabs#ipod-query-boosted-dsl-1]+======+curl::++====-[.tab-label]*curl*[source,bash]----curl -X POST http://localhost:8983/solr/techproducts/query -d '@@ -191,23 +196,24 @@ curl -X POST http://localhost:8983/solr/techproducts/query -d '}'----====-[example.tab-pane#solrj-ipod-query-boosted-dsl-1]++SolrJ::++====-[.tab-label]*SolrJ*[source,java,indent=0]----include::example$JsonRequestApiTest.java[tag=solrj-ipod-query-boosted-dsl-1]----====---+======Using the JSON Request API, with all queries fully expanded as JSON:+-[.dynamic-tabs]----[example.tab-pane#curl-ipod-query-boosted-dsl-2]+[tabs#ipod-query-boosted-dsl-2]+======+curl::++====-[.tab-label]*curl*[source,bash]----curl -X POST http://localhost:8983/solr/techproducts/query -d '@@ -226,15 +232,16 @@ curl -X POST http://localhost:8983/solr/techproducts/query -d '}'----====-[example.tab-pane#solrj-ipod-query-boosted-dsl-2]++SolrJ::++====-[.tab-label]*SolrJ*[source,java,indent=0]----include::example$JsonRequestApiTest.java[tag=solrj-ipod-query-boosted-dsl-2]----====---+========= Nested Boolean Query ExampleQuery nesting is commonly seen when combining multiple query clauses together using pseudo-boolean logic with the xref:other-parsers.adoc#boolean-query-parser[BoolQParser].@@ -242,11 +249,11 @@ Query nesting is commonly seen when combining multiple query clauses together usThe example below shows how the `BoolQParser` can be used to create powerful nested queries.In this example, a user searches for results with `iPod` in the field `name` which are _not_ in the bottom half of the `popularity` rankings.-[.dynamic-tabs]----[example.tab-pane#curl-ipod-query-bool]+[tabs#ipod-query-pool]+======+curl::++====-[.tab-label]*curl*[source,bash]----curl -X POST http://localhost:8983/solr/techproducts/query -d '@@ -265,23 +272,24 @@ curl -X POST http://localhost:8983/solr/techproducts/query -d '----====-[example.tab-pane#solrj-ipod-query-bool]++SolrJ::++====-[.tab-label]*SolrJ*[source,java,indent=0]----include::example$JsonRequestApiTest.java[tag=solrj-ipod-query-bool]----====---+======If `lucene` is the default query parser, the example above can be simplified to:-[.dynamic-tabs]----[example.tab-pane#curl-ipod-query-bool-condensed]+[tabs#ipod-query-bool-condensed]+======+curl::++====-[.tab-label]*curl*[source,bash]----curl -X POST http://localhost:8983/solr/techproducts/query -d '@@ -298,15 +306,16 @@ curl -X POST http://localhost:8983/solr/techproducts/query -d '----====-[example.tab-pane#solrj-ipod-query-bool-condensed]++SolrJ::++====-[.tab-label]*SolrJ*[source,java,indent=0]----include::example$JsonRequestApiTest.java[tag=solrj-ipod-query-bool-condensed]----====---+======Example of referencing <<Additional Queries,additional queries>>, <<Tagging in JSON Query DSL,tagging>>, and xref:other-parsers.adoc#boolean-query-parser[exclusions]:@@ -337,11 +346,11 @@ The syntaxes discussed above can also be used to specify query filters (under thFor example, the above query can be rewritten using a filter clause as:-[.dynamic-tabs]----[example.tab-pane#curl-ipod-query-bool-filter]+[tabs#ipod-query-bool-filter]+======+curl::++====-[.tab-label]*curl*[source,bash]----curl -X POST http://localhost:8983/solr/techproducts/query -d '@@ -358,15 +367,15 @@ curl -X POST http://localhost:8983/solr/techproducts/query -d '----====-[example.tab-pane#solrj-ipod-query-bool-filter]+SolrJ::++====-[.tab-label]*SolrJ*[source,java,indent=0]----include::example$JsonRequestApiTest.java[tag=solrj-ipod-query-bool-filter]----====---+======== Additional Queries@@ -411,11 +420,11 @@ For example: `{"\#title,tag2,tag3":"title:solr"}`.Note that unlike the rest of the JSON request API which uses lax JSON parsing rules, tags must be surrounded by double-quotes because of the leading `#` character.The example below creates two tagged clauses: `titleTag` and `inStockTag`.-[.dynamic-tabs]----[example.tab-pane#curl-tagged-query]+[tabs#tagged-query]+======+curl::++====-[.tab-label]*curl*[source,bash]----curl -X POST http://localhost:8983/solr/techproducts/select -d '@@ -433,15 +442,15 @@ curl -X POST http://localhost:8983/solr/techproducts/select -d '----====-[example.tab-pane#solrj-tagged-query]+SolrJ::++====-[.tab-label]*SolrJ*[source,java,indent=0]----include::example$JsonRequestApiTest.java[tag=solrj-tagged-query]----====---+======Note that the tags created in the example above have no impact in how the search is executed.Tags will not affect a query unless they are referenced by some other part of the request that uses them.diff --git a/solr/solr-ref-guide/modules/query-guide/pages/json-request-api.adoc b/solr/solr-ref-guide/modules/query-guide/pages/json-request-api.adocindex dbf45513351..7b56b48f315 100644--- a/solr/solr-ref-guide/modules/query-guide/pages/json-request-api.adoc+++ b/solr/solr-ref-guide/modules/query-guide/pages/json-request-api.adoc@@ -1,4 +1,5 @@= JSON Request API+:tabs-sync-option:// Licensed to the Apache Software Foundation (ASF) under one// or more contributor license agreements. See the NOTICE file// distributed with this work for additional information@@ -22,11 +23,12 @@ There is also some functionality which can only be accessed through this JSON re== Building JSON RequestsThe core of the JSON Request API is its ability to specify request parameters as JSON in the request body, as shown by the example below:-[.dynamic-tabs]----[example.tab-pane#curl-simple-json-query]++[tabs#simple-json-query]+======+curl::++====-[.tab-label]*curl*[source,bash]----curl http://localhost:8983/solr/techproducts/query -d '@@ -36,15 +38,16 @@ curl http://localhost:8983/solr/techproducts/query -d '}'----====-[example.tab-pane#solrj-simple-json-query]++SolrJ::++====-[.tab-label]*SolrJ*[source,java,indent=0]----include::example$JsonRequestApiTest.java[tag=solrj-json-query-simple]----====---+======JSON objects are typically sent in the request body, but they can also be sent as values for `json`-prefixed query parameters. This can be used to override or supplement values specified in the request body. For example the query parameter `json.limit=5` will override any `limit` value provided in the JSON request body. You can also specify the entire JSON body in a single `json` query parameter, as shown in the example below:[source,bash]@@ -61,11 +64,11 @@ The JSON Request API has several properties (`filter`, `fields`, etc.) which accThis layered merging gives the best of both worlds. Requests can be specified using readable, structured JSON. But users also have the flexibility to separate out parts of the request that change often. This can be seen at work in the following example, which combines `json.`-style parameters to override and supplement values found in the main JSON body.-[.dynamic-tabs]----[example.tab-pane#curl-json-query-param-overrides]+[tabs#json-query-param-overrides]+======+curl::++====-[.tab-label]*curl*[source,bash]----curl 'http://localhost:8983/solr/techproducts/query?json.limit=5&json.filter="cat:electronics"' -d '@@ -76,23 +79,24 @@ curl 'http://localhost:8983/solr/techproducts/query?json.limit=5&json.filter="ca}'----====-[example.tab-pane#solrj-json-query-param-overrides]++SolrJ::++====-[.tab-label]*SolrJ*[source,java,indent=0]----include::example$JsonRequestApiTest.java[tag=solrj-json-query-param-overrides]----====---+======This is equivalent to:-[.dynamic-tabs]----[example.tab-pane#curl-json-query-param-overrides-equivalent]+[tabs#json-query-param-overrides-equivalent]+======+curl::++====-[.tab-label]*curl*[source,bash]----curl http://localhost:8983/solr/techproducts/query -d '@@ -103,23 +107,24 @@ curl http://localhost:8983/solr/techproducts/query -d '}'----====-[example.tab-pane#solrj-json-query-param-overrides-equivalent]++SolrJ::++====-[.tab-label]*SolrJ*[source,java,indent=0]----include::example$JsonRequestApiTest.java[tag=solrj-json-query-param-overrides-equivalent]----====---+======Similarly, smart merging can be used to create JSON API requests which have no proper request body at all, such as the example below:-[.dynamic-tabs]----[example.tab-pane#curl-json-facet-all-query-params]+[tabs#json-facet-all-query-params]+======+curl::++====-[.tab-label]*curl*[source,bash]----curl http://localhost:8983/solr/techproducts/query -d 'q=*:*&rows=1&@@ -127,22 +132,23 @@ curl http://localhost:8983/solr/techproducts/query -d 'q=*:*&rows=1&json.facet.top_cats={type:terms,field:"cat",limit:3}'----====-[example.tab-pane#solrj-json-facet-all-query-params]++SolrJ::++====-[.tab-label]*SolrJ*[source,java,indent=0]----include::example$JsonRequestApiTest.java[tag=solrj-json-facet-all-query-params]----====---+======That is equivalent to the following request:-[.dynamic-tabs]----[example.tab-pane#curl-json-facet-all-query-params-equivalent]+[tabs#json-facet-all-query-params-equivalent]+======+curl::++====-[.tab-label]*curl*[source,bash]----curl http://localhost:8983/solr/techproducts/query -d '@@ -161,15 +167,16 @@ curl http://localhost:8983/solr/techproducts/query -d ''----====-[example.tab-pane#solrj-json-facet-all-query-params-equivalent]++SolrJ::++====-[.tab-label]*SolrJ*[source,java,indent=0]----include::example$JsonRequestApiTest.java[tag=solrj-json-facet-all-query-params-equivalent]----====---+======See the xref:json-facet-api.adoc[] for more on faceting and analytics commands.@@ -211,11 +218,11 @@ Right now, only some of Solr's traditional query parameters have first class JSOParameters not specified in the table above can still be used in the main body of JSON API requests, but they must be put within a `params` block as shown in the example below.-[.dynamic-tabs]----[example.tab-pane#curl-json-query-params-block]+[tabs#json-query-params-block]+======+curl::++====-[.tab-label]*curl*[source,bash]----curl "http://localhost:8983/solr/techproducts/query?fl=name,price"-d '@@ -228,16 +235,15 @@ curl "http://localhost:8983/solr/techproducts/query?fl=name,price"-d '----====-[example.tab-pane#solrj-json-query-params-block]+SolrJ::++====-[.tab-label]*SolrJ*-[source,java,indent=0]----include::example$JsonRequestApiTest.java[tag=solrj-json-query-params-block]----====---+======Parameters placed in a `params` block act as if they were added verbatim to the query-parameters of the request. The request above is equivalent to:@@ -253,11 +259,11 @@ Usage of `queries` key is described in xref:json-query-dsl.adoc#additional-queriOf course request templating via parameter substitution works fully with JSON request bodies or parameters as well.For example:-[.dynamic-tabs]----[example.tab-pane#curl-json-query-macro-expansion]+[tabs#json-query-macro-expansion]+======+curl::++====-[.tab-label]*curl*[source,bash]----curl "http://localhost:8983/solr/techproducts/query?FIELD=text&TERM=memory" -d '@@ -267,16 +273,15 @@ curl "http://localhost:8983/solr/techproducts/query?FIELD=text&TERM=memory" -d '----====-[example.tab-pane#solrj-json-query-macro-expansion]+SolrJ::++====-[.tab-label]*SolrJ*-[source,java,indent=0]----include::example$JsonRequestApiTest.java[tag=solrj-json-query-macro-expansion]----====---+========= JSON Extensionsdiff --git a/solr/solr-ref-guide/modules/query-guide/pages/morelikethis.adoc b/solr/solr-ref-guide/modules/query-guide/pages/morelikethis.adocindex 775b699d97a..e329ca0977e 100644--- a/solr/solr-ref-guide/modules/query-guide/pages/morelikethis.adoc+++ b/solr/solr-ref-guide/modules/query-guide/pages/morelikethis.adoc@@ -1,4 +1,5 @@= MoreLikeThis+:tabs-sync-option:// Licensed to the Apache Software Foundation (ASF) under one// or more contributor license agreements. See the NOTICE file// distributed with this work for additional information@@ -187,12 +188,11 @@ Multi-shard support is, however, available with the MoreLikeThis request handlerThe MoreLikeThis request handler is not configured by default and needs to be set up before using it.You can do this by manually editing `solrconfig.xml` or with the Config API:-[.dynamic-tabs]----[example.tab-pane#manualconfig]+[tabs#manual-config]+======+Manual Configuration::++====-[.tab-label]*Manual Configuration*-[source,xml]----<requestHandler name="/mlt" class="solr.MoreLikeThisHandler">@@ -201,10 +201,9 @@ You can do this by manually editing `solrconfig.xml` or with the Config API:----====-[example.tab-pane#configapi]+Config API::++====-[.tab-label]*Config API*-[source,bash]----curl -X POST -H 'Content-type:application/json' -d {@@ -216,7 +215,7 @@ curl -X POST -H 'Content-type:application/json' -d {} http://localhost:8983/solr/<collection>/config----====---+======Both of the above examples set the `mlt.fl` parameter to "body" for the request handler.This means that all requests to the handler will use that value for the parameter unless specifically overridden in an individual request.diff --git a/solr/solr-ref-guide/modules/upgrade-notes/pages/major-changes-in-solr-7.adoc b/solr/solr-ref-guide/modules/upgrade-notes/pages/major-changes-in-solr-7.adocindex 1aab84288c9..9dedd41ae7e 100644--- a/solr/solr-ref-guide/modules/upgrade-notes/pages/major-changes-in-solr-7.adoc+++ b/solr/solr-ref-guide/modules/upgrade-notes/pages/major-changes-in-solr-7.adoc@@ -1,4 +1,5 @@= Major Changes in Solr 7+:tabs-sync-option:// Licensed to the Apache Software Foundation (ASF) under one// or more contributor license agreements. See the NOTICE file// distributed with this work for additional information@@ -102,26 +103,26 @@ If you do not need to sort or facet on a field, you should remove the automaticaAutomatic field creation can be disabled with the `update.autoCreateFields` property.To do this, you can use the Config API with a command such as:-[.dynamic-tabs]----[example.tab-pane#v1setprop]+[tabs#setprop]+======+V1 API::++====-[.tab-label]*V1 API*[source,bash]----curl http://host:8983/solr/mycollection/config -d '{"set-user-property": {"update.autoCreateFields":"false"}}'----====-[example.tab-pane#v2setprop]+V2 API::++====-[.tab-label]*V2 API*[source,bash]----curl http://host:8983/api/collections/mycollection/config -d '{"set-user-property": {"update.autoCreateFields":"false"}}'----====---+========= Changes to Default Behaviors* JSON is now the default response format.diff --git a/solr/solr-ref-guide/playbook.template.yml b/solr/solr-ref-guide/playbook.template.ymlindex 3b120a1c681..ad283d03392 100644--- a/solr/solr-ref-guide/playbook.template.yml+++ b/solr/solr-ref-guide/playbook.template.yml@@ -38,6 +38,9 @@ ui:bundle:url: 'https://nightlies.apache.org/solr/solr-reference-guide-ui-bundle/ui-bundle.zip'snapshot: true+ supplemental_files:+ - path: js/vendor/tabs.js+ contents: ~+/node_modules/@asciidoctor/tabs/dist/js/tabs.jsoutput:clean: truedir: '${site_dir}'@@ -46,6 +49,7 @@ asciidoc:stem:extensions:- '@djencks/asciidoctor-mathjax'+ - '@asciidoctor/tabs'runtime:fetch: truediff --git a/solr/solr-ref-guide/ui-src/css/site.css b/solr/solr-ref-guide/ui-src/css/site.cssindex e345927857d..c04173ee6d5 100644--- a/solr/solr-ref-guide/ui-src/css/site.css+++ b/solr/solr-ref-guide/ui-src/css/site.css@@ -18,3 +18,4 @@@import "footer.css";@import "highlight.css";@import "print.css";+@import "tabs.css";diff --git a/solr/solr-ref-guide/ui-src/css/tabs.css b/solr/solr-ref-guide/ui-src/css/tabs.cssnew file mode 100644index 00000000000..dffbcdf961c--- /dev/null+++ b/solr/solr-ref-guide/ui-src/css/tabs.css@@ -0,0 +1,103 @@+.tabs {+ margin-top: 1em;+ margin-bottom: 1.25em;+}++.tablist > ul {+ display: flex;+ flex-wrap: wrap;+ list-style: none;+ margin: 0;+ padding: 0;+}++.tablist > ul li {+ align-items: center;+ background-color: #fff;+ cursor: pointer;+ display: flex;+ font-weight: bold;+ line-height: 1.5;+ padding: 0.5em 1.25em;+ position: relative;+ margin: 0 0 -1px !important;+}++.tablist > ul li:focus-visible {+ outline: none;+}++.tablist.ulist,+.tablist.ulist > ul li {+ margin: 0;+}++.tablist.ulist > ul li + li {+ margin-left: 0.25em;+}++.tabs .tablist li::after {+ content: "";+ display: block;+ height: 1px;+ position: absolute;+ bottom: -1px;+ left: 0;+ right: 0;+}++.tabs.is-loading .tablist li:not(:first-child),+.tabs:not(.is-loading) .tablist li:not(.is-selected) {+ background-color: transparent;+}++.tabs.is-loading .tablist li:first-child::after,+.tabs:not(.is-loading) .tablist li.is-selected::after {+ background-color: transparent;+}++.tablist .is-selected {+ color: #d9411e;+ border: 1px solid #5d5d5d;+ border-radius: 5px 5px 0 0;+ border-bottom: 1px solid transparent;+}++.tablist > ul p {+ line-height: inherit;+ margin: 0;+}++.tabpanel .exampleblock > .content {+ background-color: #fff;+ border: 1px solid #5d5d5d;+ border-radius: 0 0 5px 5px;+}++.tabs.is-loading .tabpanel + .tabpanel,+.tabs:not(.is-loading) .tabpanel.is-hidden {+ display: none;+}++.tabpanel > :first-child {+ margin-top: 0;+}++/* #content is a signature of the Asciidoctor standalone HTML output */+#content .tabpanel > :last-child,+#content .tabpanel > :last-child > :last-child,+#content .tabpanel > :last-child > :last-child > li:last-child > :last-child {+ margin-bottom: 0;+}++.tablecontainer {+ overflow-x: auto;+}++#content .tablecontainer {+ margin-bottom: 1.25em;+}++#content .tablecontainer > table.tableblock {+ margin-bottom: 0;+}diff --git a/solr/solr-ref-guide/ui-src/partials/footer-content.hbs b/solr/solr-ref-guide/ui-src/partials/footer-content.hbsindex 1d00a84edb3..4602e17883b 100644--- a/solr/solr-ref-guide/ui-src/partials/footer-content.hbs+++ b/solr/solr-ref-guide/ui-src/partials/footer-content.hbs@@ -1,5 +1,6 @@<footer class="footer"><!-- Solr Changes - Start --><p> © Apache Software Foundation. All rights reserved.</p>+ <script async src="{{{uiRootPath}}}/js/vendor/tabs.js"></script><!-- Solr Changes - End --></footer>