Bug 1035940

Summary: The name "Infinispan Query" is used where it should actually be "Hibernate Search"
Product: [JBoss] JBoss Data Grid 6 Reporter: Adrian Nistor <anistor>
Component: DocumentationAssignee: Misha H. Ali <mhusnain>
Status: CLOSED CURRENTRELEASE QA Contact:
Severity: high Docs Contact:
Priority: unspecified    
Version: 6.2.0CC: anistor, dmehra, gsheldon, jdg-bugs, mgencur, mmarkus, sanne, vchepeli
Target Milestone: GA   
Target Release: 6.2.0   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2014-01-16 00:03:35 UTC Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:

Description Adrian Nistor 2013-11-28 23:16:01 UTC
Build Name: 14318, Infinispan Query Guide-6.2-1

There are many places were the name 'Hibernate Search' was replaced with 'Infinispan Query'. This is very confusing. Infinispan Query is not another name for Hibernate Search. It is something that incorporates Hibernate Search, and the name Hibernate Search must be maintained whenever we refer to it.

A severe problem induced by this is now we have two DSLs. One is the DSL that comes from Hibernate Search, and can be used in embedded mode only.

The other DSL was newly introduced in Infinispan (presented in 6.1. The Query DSL), and can be used in both embedded and remote mode. They are different, but are called the same.

Comment 2 Misha H. Ali 2013-11-29 06:25:57 UTC
OK, I'm going to revert back to HS instead of IQ and list each topic I have made this change so that Adrian (or someone else) can check the context and confirm they should all be HS:

Changed:

* 1.3.1. Infinispan Query and the Query Module
* 1.3.2. Apache Lucene and Infinispan Query
* 1.4. Indexing
* 1.5. Batching
* 1.7. Analyzer
* 3.1. Annotating Objects for Hibernate Search <-- changed title here too
* 4.1. Basic Mapping
* 4.3.2. @IndexedEmbedded
* 4.3.3. The targetElement Property
* 4.5. Analysis
* 4.5.2. Named Analyzers
* 4.5.6. Dynamic Analyzer Selection
* 4.5.7. Retrieving an Analyzer
* 4.6. Bridges
* 4.6.1. Built-in Bridges
* 4.6.2. Custom Bridges
* 4.6.2.2. StringBridge
* 4.6.2.3. Two-Way Bridge
* Chapter 5. Querying
* 5.1. Building Queries
* 5.1.2. Building a Lucene Query
* 5.1.3.1. Generality
* 5.1.3.4. Fetching Strategy
* 5.1.3.5. Projection
* 5.1.3.7. Limiting the Time of a Query
* 5.2. Retrieving the Results
* 5.2.1. Performance Considerations
* 5.2.2. Result Size
* 5.2.4. Understanding Results
* 5.3.1. Defining and Implementing a Filter
* 5.3.2. The @Factory Filter
* 5.3.4. Full Text Filter
* 5.4.1. Caching Index Values: FieldCache
* Chapter 7. Monitoring

No Change Made:

* 1.1. Introduction
* 1.2. Downloading Infinispan Query
* 1.4.2. Using the Index Manager
* 1.6. Searching
* 2.1. Set Up Infinispan Query
* 2.1.1. Infinispan Query Dependencies
* 2.1.2. Infinispan Query Configuration Example
* 2.2.1. Configure the Query Module
* 2.2.2. Configure Indexing using XML
* 6.1. The Query DSL
* 6.1.1. Enabling DSL-based Queries
* 6.2. Protobuf Marshaller

Comment 3 Misha H. Ali 2013-12-02 23:28:09 UTC
*** Bug 1036869 has been marked as a duplicate of this bug. ***

Comment 4 Misha H. Ali 2013-12-02 23:29:52 UTC
I have mentioned in comment #2 where I have changed IQ to HS. I have also mentioned where IQ was retained because it seemed to make sense.

If we can get an SME to review this (admittedly long) list within this week, I can quickly implement changes.

Comment 5 Divya Mehra 2013-12-04 02:22:27 UTC
I think we are interested only in this DSL for JDG 6.2, primarily in the context of Querying over Hot Rod:
>>> The other DSL was newly introduced in Infinispan (presented in 6.1. The Query DSL), and can be used in both embedded and remote mode. 

I assume that all references to "DSL" apply to this new DSL developed in Infinispan 6.0?


>> A severe problem induced by this is now we have two DSLs. One is the DSL that comes from Hibernate Search, and can be used in embedded mode only.

Didn't understand this second DSL for embedded mode. Aren't we supporting only the Java APIs for Embedded Querying?

Comment 6 Martin Gencur 2013-12-04 12:40:26 UTC
>>>I assume that all references to "DSL" apply to this new DSL developed in Infinispan 6.0?

No. The documentation mixes two DSL - Hibernate Search Query DSL and Infinispan Query DSL. I'll go through the documentation and make sure we always use either "Hibernate Search Query" or "Infinispan Query" prefix when talking about respective DSLs.

>>>Didn't understand this second DSL for embedded mode. Aren't we supporting only the Java APIs for Embedded Querying?

We fully support Hibernate Search Query DSL. The Infinispan Query DSL is only Tech. Preview, both for client-server and library (embedded) mode.

Note that currently using both the DSLs results in queries which internally use Apache Lucene search engine.

Comment 8 Martin Gencur 2013-12-05 09:24:38 UTC
* 1.3.1. Infinispan Query and the Query Module

Did we miss changing back also the title? "Infinispan Query and the Query Module" -> "Hibernate Search and the Query Module" ?
Otherwise looks good

* 1.7. Analyzer

removed chapter, OK

* 4.6. Bridges

Now there's "Hibernate Query". Should be changed to "Hibernate Search"

* 5.1.3.1. Generality

Change "Hibernate query" to "Infinispan CacheQuery"

* 5.1.3.5. Projection

"Use Hibernate Search to return.." should be actually "Use Infinispan Query to return"

* 5.1.3.7. Limiting the Time of a Query

Should be Infinispan Query instead of Hibernate Search. The code snippet is wrong and will be chagned 
to use CacheQuery instead of FullTextQuery. Hence the usage of "Infinispan Query"

* 5.2. Retrieving the Results

Should be Infinispan Query, this topic will need to be changed.

* 5.2.1. Performance Considerations

No Change Made:

* 1.1. Introduction

OK. However the sentence starting with "This guide only contains .." should be probably removed. We provide quite a lot of info about hibernate search in the docs.

* 1.4.2. Using the Index Manager - 

This was removed, OK

* 1.6. Searching

It is now 1.5 and there's an "error".

* 2.1.2. Infinispan Query Configuration Example

Topic removed, ok.

* 2.2.2. Configure Indexing using XML

Should be probably "Hibernate Search"

* 6.1.1. Enabling DSL-based Queries

The sentence "The following is an example of Infinispan Query annotated entity" should be "The following is an example of Hibernate Search annotated entity"

The remaining topics look good from this POV.

Comment 19 Misha H. Ali 2014-01-06 01:54:39 UTC
This looks ready for QA to me. Flagging Vitalii

Comment 20 Misha H. Ali 2014-01-16 00:03:35 UTC
The fix for this bug is now generally released and available here:

https://access.redhat.com/site/documentation/en-US/Red_Hat_JBoss_Data_Grid/6.2/index.html