SOLR-14092: Mark BlockJoinFacetComponent as deprecated.

This commit is contained in:
Mikhail Khludnev 2019-12-14 23:23:40 +03:00
parent d1fa6e1e02
commit cc00e1dcef
4 changed files with 15 additions and 3 deletions

View File

@ -33,6 +33,8 @@ Upgrade Notes
* SOLR-14026: Upgrade Jetty to 9.4.24.v20191120 and dropwizard to 4.1.2 (Erick Erickson)
* SOLR-14092: BlockJoinFacetComponent is marked for deprecation and will be removed in 9.0.
Users are encouraged to migrate to uniqueBlock() in JSON Facet API. (Mikhail Khludnev)
New Features
---------------------

View File

@ -40,7 +40,11 @@ import org.apache.solr.search.join.BlockJoinFieldFacetAccumulator.AggregatableDo
* Calculates facets on children documents and aggregates hits by parent documents.
* Enables when child.facet.field parameter specifies a field name for faceting.
* So far it supports string fields only. It requires to search by {@link ToParentBlockJoinQuery}.
* */
*
* @deprecated This functionality is considered deprecated and will be removed at 9.0
* Users are encouraged to use <code>"uniqueBlock(\_root_)"</code> aggregation
* under <code>"terms"</code> facet and <code>"domain": { "blockChildren":...}</code> */
@Deprecated
public class BlockJoinDocSetFacetComponent extends BlockJoinFacetComponentSupport {
private final String bjqKey = this.getClass().getSimpleName()+".bjq";

View File

@ -17,7 +17,12 @@
package org.apache.solr.search.join;
/** this is just a stub refers to {@link BlockJoinDocSetFacetComponent} to avoid
* changes in configs */
* changes in configs
*
* @deprecated This functionality is considered deprecated and will be removed at 9.0
* Users are encouraged to use <code>"uniqueBlock(\_root_)"</code> aggregation
* under <code>"terms"</code> facet and <code>"domain": { "blockChildren":...}</code> */
@Deprecated
public class BlockJoinFacetComponent extends BlockJoinDocSetFacetComponent {
}

View File

@ -20,7 +20,8 @@ BlockJoin facets allow you to aggregate children facet counts by their parents.
It is a common requirement that if a parent document has several children documents, all of them need to increment facet value count only once. This functionality is provided by `BlockJoinDocSetFacetComponent`, and `BlockJoinFacetComponent` just an alias for compatibility.
CAUTION: This functionality is considered deprecated. Users are encouraged to use `uniqueBlock(\_root_)` aggregation under a `terms` facet in the <<json-faceting-domain-changes.adoc#block-join-domain-changes,JSON Facet API>>.
CAUTION: This functionality is considered deprecated and will be removed at 9.0.
Users are encouraged to use `uniqueBlock(\_root_)` aggregation under a `terms` facet in the <<json-faceting-domain-changes.adoc#block-join-domain-changes,JSON Facet API>>.
If this component is used, it must be explicitly enabled for a request handler in `solrconfig.xml`, in the same way as any other <<requesthandlers-and-searchcomponents-in-solrconfig.adoc#requesthandlers-and-searchcomponents-in-solrconfig,search component>>.
This example shows how you could add this search components to `solrconfig.xml` and define it in request handler: