API del Generador de consultas query-builder-api

AEM El Generador de consultas es una forma sencilla de consultar el repositorio de contenido de las consultas de los recursos de la. La funcionalidad se expone a través de una API de Java™ y una API de REST. Este documento describe estas API.

El generador de consultas del lado del servidor (QueryBuilder) acepta una descripción de la consulta, crea y ejecuta una consulta XPath, opcionalmente filtra el conjunto de resultados y también extrae facetas, si lo desea.

La descripción de la consulta es simplemente un conjunto de predicados (Predicate). Algunos ejemplos son un predicado de texto completo, que corresponde a la variable jcr:contains() función en XPath.

Para cada tipo de predicado, hay un componente evaluador (PredicateEvaluator) que sabe cómo gestionar ese predicado específico para XPath, filtrado y extracción de facetas. Es fácil crear evaluadores personalizados, que están conectados a través del tiempo de ejecución del componente OSGi.

La API de REST proporciona acceso a las mismas funciones a través de HTTP con respuestas enviadas en JSON.

NOTE
La API de QueryBuilder se crea mediante la API de JCR. AEM También puede consultar el JCR de la utilizando la API de JCR desde un paquete OSGi. Para obtener más información, consulte Consulta de datos de Adobe Experience Manager mediante la API de JCR.

Sesión de Gem gem-session

AEM Gems de es una serie de conocimientos técnicos en Adobe Experience Manager proporcionados por expertos en Adobe.

Puede revise la sesión dedicada al generador de consultas para obtener información general y utilizar la herramienta.

Consultas de muestra sample-queries

Estos ejemplos se proporcionan en notación de estilo de propiedades Java™. Para utilizarlos con la API de Java™, utilice un Java™ HashMap como en el ejemplo de API que sigue.

Para el QueryBuilder AEM Servlet JSON; cada ejemplo incluye un vínculo de ejemplo a una instalación de (en la ubicación predeterminada, http://<host>:<port>). AEM Inicie sesión en la instancia de antes de utilizar estos vínculos.

CAUTION
De forma predeterminada, el servlet JSON del generador de consultas muestra un máximo de diez visitas.
Añadir el siguiente parámetro permite que el servlet muestre todos los resultados de la consulta:
p.limit=-1
NOTE
Para ver los datos JSON devueltos en el navegador, es posible que desee utilizar un complemento como JSONView para Firefox.

Devolver todos los resultados returning-all-results

La siguiente consulta devuelve diez resultados (o para ser precisos, un máximo de diez), pero le informa de la Número de visitas: que está disponible:

http://<host>:<port>/bin/querybuilder.json?path=/content&1_property=sling:resourceType&1_property.value=wknd/components/structure/page&1_property.operation=like&orderby=path

path=/content
1_property=sling:resourceType
1_property.value=wknd/components/structure/page
1_property.operation=like
orderby=path

La misma consulta (con el parámetro ) p.limit=-1) devuelve todos los resultados (puede ser un número alto según la instancia):

http://<host>:<port>/bin/querybuilder.json?path=/content&1_property=sling:resourceType&1_property.value=wknd/components/structure/page&1_property.operation=like&orderby=path&p.limit=-1

path=/content
1_property=sling:resourceType
1_property.value=wknd/components/structure/page
1_property.operation=like
p.limit=-1
orderby=path

Uso de p.guessTotal para devolver los resultados using-p-guesstotal-to-return-the-results

El propósito de la p.guessTotal es devolver el número adecuado de resultados que se pueden mostrar combinando el mínimo viable p.offset y p.limit valores. La ventaja de utilizar este parámetro es un rendimiento mejorado con grandes conjuntos de resultados. Este parámetro también evita calcular el total completo (por ejemplo, llamar a result.getSize()) y leer el conjunto de resultados completo, optimizado hasta el motor Oak y el índice. Este proceso puede ser una diferencia significativa cuando hay cientos de miles de resultados, tanto en tiempo de ejecución como en uso de memoria.

La desventaja del parámetro es que los usuarios no ven el total exacto. Pero puede establecer un número mínimo como p.guessTotal=1000 así que siempre se lee hasta 1000. De este modo, se obtienen totales exactos para conjuntos de resultados más pequeños, pero si es más, solo se puede mostrar "y más".

Añadir p.guessTotal=true Consulte la siguiente consulta para ver cómo funciona:

http://<host>:<port>/bin/querybuilder.json?path=/content&1_property=sling:resourceType&1_property.value=wknd/components/structure/page&1_property.operation=like&p.guessTotal=true&orderby=path

path=/content
1_property=sling:resourceType
1_property.value=wknd/components/structure/page
1_property.operation=like
p.guessTotal=true
orderby=path

La consulta devuelve el p.limit valor predeterminado de 10 resultados con a 0 desplazamiento:

"success": true,
"results": 10,
"total": 10,
"more": true,
"offset": 0,

También puede utilizar un valor numérico para contar hasta un número personalizado de resultados máximos. Utilice la misma consulta que la anterior, pero cambie el valor de p.guessTotal hasta 50:

http://<host>:<port>/bin/querybuilder.json?path=/content&1_property=sling:resourceType&1_property.value=wknd/components/structure/page&1_property.operation=like&p.guessTotal=50&orderby=path

Devuelve un número con el mismo límite predeterminado de 10 resultados con un desplazamiento de 0, pero solo muestra un máximo de 50 resultados:

"success": true,
"results": 10,
"total": 50,
"more": true,
"offset": 0,

Implementación de paginación implementing-pagination

De forma predeterminada, el Generador de consultas también proporcionaría el número de visitas. En función del tamaño del resultado, este número puede tardar mucho tiempo, ya que determinar el recuento preciso implica comprobar todos los resultados para el control de acceso. La mayoría del total se utiliza para implementar la paginación en la interfaz de usuario del usuario final. Como determinar el recuento exacto puede ser lento, se recomienda utilizar la función guessTotal para implementar la paginación.

Por ejemplo, la IU de puede adaptar el siguiente enfoque:

  • Obtenga y muestre el recuento preciso del número total de visitas (SearchResult.getTotalMatches() o total en el querybuilder.json Respuesta) son inferiores o iguales a 100;

  • Establecer guessTotal a 100 llamando al Generador de consultas.

  • La respuesta puede tener el siguiente resultado:

    • total=43, more=false - Indica que el número total de visitas es 43. La interfaz de usuario puede mostrar hasta diez resultados como parte de la primera página y proporcionar paginación para las tres páginas siguientes. También puede utilizar esta implementación para mostrar un texto descriptivo como "43 resultados encontrados".
    • total=100, more=true - Indica que el número total de visitas es mayor que 100 y que se desconoce el recuento exacto. La IU puede mostrarse hasta diez como parte de la primera página y proporcionar paginación para las siguientes diez páginas. También puede utilizar esta función para mostrar un texto como "se han encontrado más de 100 resultados". A medida que el usuario va a las páginas siguientes, las llamadas realizadas al Generador de consultas aumentarían el límite de guessTotal y también del offset y limit parámetros.

Además, utilice guessTotal en casos en los que la interfaz de usuario debe utilizar desplazamiento infinito para evitar que el Generador de consultas determine el recuento exacto de visitas.

Buscar archivos jar y pedirlos, primero el más reciente find-jar-files-and-order-them-newest-first

http://<host>:<port>/bin/querybuilder.json?type=nt:file&nodename=*.jar&orderby=@jcr:content/jcr:lastModified&orderby.sort=desc

type=nt:file
nodename=*.jar
orderby=@jcr:content/jcr:lastModified
orderby.sort=desc

Buscar todas las páginas y ordenarlas por última modificación find-all-pages-and-order-them-by-last-modified

http://<host>:<port>/bin/querybuilder.json?type=cq:Page&orderby=@jcr:content/cq:lastModified

type=cq:Page
orderby=@jcr:content/cq:lastModified

Buscar todas las páginas y ordenarlas por última modificación, descendente find-all-pages-and-order-them-by-last-modified-but-descending

http://<host>:<port>/bin/querybuilder.json?type=cq:Page&orderby=@jcr:content/cq:lastModified&orderby.sort=desc

type=cq:Page
orderby=@jcr:content/cq:lastModified
orderby.sort=desc

Búsqueda de texto completo, ordenada por puntuación fulltext-search-ordered-by-score

http://<host>:<port>/bin/querybuilder.json?fulltext=Management&orderby=@jcr:score&orderby.sort=desc

fulltext=Management
orderby=@jcr:score
orderby.sort=desc

Buscar páginas con una etiqueta determinada search-for-pages-tagged-with-a-certain-tag

http://<host>:<port>/bin/querybuilder.json?type=cq:Page&tagid=wknd:activity/cycling&tagid.property=jcr:content/cq:tags

type=cq:Page
tagid=wknd:activity/cycling
tagid.property=jcr:content/cq:tags

Utilice el tagid predicado como en el ejemplo si conoce el ID de etiqueta explícito.

Utilice el tag predicado para la ruta del título de la etiqueta (sin espacios).

En el ejemplo anterior, porque está buscando páginas (cq:Page nodos), utilice la ruta relativa de ese nodo para el tagid.property predicado, que es jcr:content/cq:tags. De forma predeterminada, la variable tagid.property sería cq:tags.

Buscar varias rutas (mediante grupos) search-under-multiple-paths-using-groups

http://<host>:<port>/bin/querybuilder.json?fulltext=Experience&group.1_path=/content/wknd/us/en/magazine&group.2_path=/content/wknd/us/en/adventures&group.p.or=true

fulltext=Experience
group.p.or=true
group.1_path=/content/wknd/us/en/magazine
group.2_path=/content/wknd/us/en/adventures

Esta consulta utiliza un grupo (denominado group), que actúa para delimitar subexpresiones dentro de una consulta, como lo hacen los paréntesis en las notaciones más estándar. Por ejemplo, la consulta anterior podría expresarse con un estilo más familiar como:

"Experience" and ("/content/wknd/us/en/magazine" or "/content/wknd/us/en/adventures")

Dentro del grupo del ejemplo, la variable path predicado se utiliza varias veces. Para diferenciar y ordenar las dos instancias del predicado (se requiere el orden para algunos predicados), debe incluir como prefijo los predicados N_ donde N es el índice de ordenación. En el ejemplo anterior, los predicados resultantes son 1_path y 2_path.

El p in p.or es un delimitador especial que indica que lo que sigue (en este caso un or) es un parámetro del grupo, a diferencia de un subpredicado del grupo, como, por ejemplo, 1_path.

Si no p.or se da, entonces todos los predicados se unen ANDed, es decir, cada resultado debe satisfacer todos los predicados.

NOTE
No puede utilizar el mismo prefijo numérico en una sola consulta, incluso para diferentes predicados.

Buscar propiedades search-for-properties

Aquí está buscando todas las páginas de una plantilla determinada, utilizando el cq:template propiedad:

http://<host>:<port>/bin/querybuilder.json?property=cq%3atemplate&property.value=%2fconf%2fwknd%2fsettings%2fwcm%2ftemplates%2fadventure-page-template&type=cq%3aPageContent

type=cq:PageContent
property=cq:template
property.value=/conf/wknd/settings/wcm/templates/adventure-page-template

El inconveniente es que la jcr:content se devuelven los nodos de las páginas, no las páginas en sí. Para resolver este problema, puede buscar por ruta relativa:

http://<host>:<port>/bin/querybuilder.json?property=jcr%3acontent%2fcq%3atemplate&property.value=%2fconf%2fwknd%2fsettings%2fwcm%2ftemplates%2fadventure-page-template&type=cq%3aPage

type=cq:Page
property=jcr:content/cq:template
property.value=/conf/wknd/settings/wcm/templates/adventure-page-template

Buscar varias propiedades search-for-multiple-properties

Cuando utilice el predicado de propiedad varias veces, debe volver a agregar el número de prefijos:

http://<host>:<port>/bin/querybuilder.json?1_property=jcr%3acontent%2fcq%3atemplate&1_property.value=%2fconf%2fwknd%2fsettings%2fwcm%2ftemplates%2fadventure-page-template&2_property=jcr%3acontent%2fjcr%3atitle&2_property.value=Cycling%20Tuscany&type=cq%3aPage

type=cq:Page
1_property=jcr:content/cq:template
1_property.value=/conf/wknd/settings/wcm/templates/adventure-page-template
2_property=jcr:content/jcr:title
2_property.value=Cycling Tuscany

Buscar varios valores de propiedad search-for-multiple-property-values

Para evitar grupos grandes cuando desee buscar varios valores de una propiedad ("A" or "B" or "C"), puede proporcionar varios valores al property predicado:

http://<host>:<port>/bin/querybuilder.json?property=jcr%3atitle&property.1_value=Cycling%20Tuscany&property.2_value=Ski%20Touring&property.3_value=Whistler%20Mountain%20Biking

property=jcr:title
property.1_value=Cycling Tuscany
property.2_value=Ski Touring
property.3_value=Whistler Mountain Biking

Para las propiedades de varios valores, también puede requerir que varios valores coincidan con ("A" and "B" and "C"):

http://<host>:<port>/bin/querybuilder.json?property=jcr%3atitle&property.and=true&property.1_value=Cycling%20Tuscany&property.2_value=Ski%20Touring&property.3_value=Whistler%20Mountain%20Biking

property=jcr:title
property.and=true
property.1_value=Cycling Tuscany
property.2_value=Ski Touring
property.3_value=Whistler Mountain Biking

Refinamiento de los elementos devueltos refining-what-is-returned

De forma predeterminada, el servlet JSON de QueryBuilder devuelve un conjunto predeterminado de propiedades para cada nodo en el resultado de búsqueda (por ejemplo, ruta, nombre y título). Para obtener control sobre las propiedades que se devuelven, puede realizar una de las siguientes acciones:

Especificar

p.hits=full

En cuyo caso, todas las propiedades se incluyen para cada nodo:

http://<host>:<port>/bin/querybuilder.json?p.hits=full&property=jcr%3atitle&property.value=Cycling%20Tuscany

property=jcr:title
property.value=Cycling Tuscany
p.hits=full

Uso

p.hits=selective

Y especifique las propiedades en las que desea entrar

p.properties

Separado por un espacio:

http://<host>:<port>/bin/querybuilder.json?p.hits=selective&p.properties=sling%3aresourceType%20jcr%3aprimaryType&property=jcr%3atitle&property.value=Cycling%20Tuscany

property=jcr:title
property.value=Cycling Tuscany
p.hits=selective
p.properties=sling:resourceType jcr:primaryType

Otra cosa que puede hacer es incluir nodos secundarios en la respuesta del Generador de consultas. Especificar

p.nodedepth=n

Donde n es el número de niveles que desea que devuelva la consulta. Para que se devuelva un nodo secundario, debe especificarlo el selector de propiedades

p.hits=full

Ejemplo:

http://<host>:<port>/bin/querybuilder.json?p.hits=full&p.nodedepth=5&property=jcr%3atitle&property.value=Cycling%20Tuscany

property=jcr:title
property.value=Cycling Tuscany
p.hits=full
p.nodedepth=5

Más predicados morepredicates

Para ver más predicados, consulte la Página Generador de Consultas: Referencia de Predicados.

También puede consultar la Javadoc para PredicateEvaluator clases. El Javadoc para estas clases contiene la lista de propiedades que puede utilizar.

El prefijo del nombre de clase (por ejemplo, similar in SimilarityPredicateEvaluator) es el propiedad principal de la clase. Esta propiedad también es el nombre del predicado que se utilizará en la consulta (en minúsculas).

Para estas propiedades principales, puede acortar la consulta y utilizar similar=/content/en en lugar de la variante completa similar.similar=/content/en. El formulario completo debe utilizarse para todas las propiedades no principales de una clase.

Ejemplo de uso de API de Query Builder example-query-builder-api-usage

   String fulltextSearchTerm = "WKND";

    // create query description as hash map (simplest way, same as form post)
    Map<String, String> map = new HashMap<String, String>();

// create query description as hash map (simplest way, same as form post)
    map.put("path", "/content");
    map.put("type", "cq:Page");
    map.put("group.p.or", "true"); // combine this group with OR
    map.put("group.1_fulltext", fulltextSearchTerm);
    map.put("group.1_fulltext.relPath", "jcr:content");
    map.put("group.2_fulltext", fulltextSearchTerm);
    map.put("group.2_fulltext.relPath", "jcr:content/@cq:tags");

    // can be done in map or with Query methods
    map.put("p.offset", "0"); // same as query.setStart(0) below
    map.put("p.limit", "20"); // same as query.setHitsPerPage(20) below

    Query query = builder.createQuery(PredicateGroup.create(map), session);
    query.setStart(0);
    query.setHitsPerPage(20);

    SearchResult result = query.getResult();

    // paging metadata
    int hitsPerPage = result.getHits().size(); // 20 (set above) or lower
    long totalMatches = result.getTotalMatches();
    long offset = result.getStartIndex();
    long numberOfPages = totalMatches / 20;

    //Place the results in XML to return to client
    DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
    DocumentBuilder builder = factory.newDocumentBuilder();
    Document doc = builder.newDocument();

    //Start building the XML to pass back to the AEM client
    Element root = doc.createElement( "results" );
    doc.appendChild( root );

    // iterating over the results
for (Hit hit : result.getHits()) {
       String path = hit.getPath();

      //Create a result element
      Element resultel = doc.createElement( "result" );
      root.appendChild( resultel );

      Element pathel = doc.createElement( "path" );
      pathel.appendChild( doc.createTextNode(path ) );
      resultel.appendChild( pathel );
    }

La misma consulta ejecutada a través de HTTP mediante el servlet Query Builder (JSON):

http://<host>:<port>/bin/querybuilder.json?path=/content&type=cq:Page&group.p.or=true&group.1_fulltext=WKND&group.1_fulltext.relPath=jcr:content&group.2_fulltext=WKND&group.2_fulltext.relPath=jcr:content/@cq:tags&p.offset=0&p.limit=20

Almacenar y cargar consultas storing-and-loading-queries

Las consultas se pueden almacenar en el repositorio para poder utilizarlas más adelante. El QueryBuilder proporciona el storeQuery método con la siguiente firma:

void storeQuery(Query query, String path, boolean createFile, Session session) throws RepositoryException, IOException;

Al usar el QueryBuilder#storeQuery método, el determinado Query se almacena en el repositorio como un archivo o como una propiedad según el createFile valor de argumento. El siguiente ejemplo muestra cómo guardar un Query a la ruta /mypath/getfiles como archivo:

builder.storeQuery(query, "/mypath/getfiles", true, session);

Las consultas almacenadas anteriormente se pueden cargar desde el repositorio mediante la variable QueryBuilder#loadQuery método:

Query loadQuery(String path, Session session) throws RepositoryException, IOException

Por ejemplo, una Query almacenado en la ruta /mypath/getfiles se puede cargar mediante el siguiente fragmento de código:

Query loadedQuery = builder.loadQuery("/mypath/getfiles", session);

Pruebas y depuración testing-and-debugging

Para jugar y depurar consultas del Generador de consultas, puede utilizar la consola del depurador del Generador de consultas en

http://<host>:<port>/libs/cq/search/content/querydebug.html

O bien, el servlet JSON de Query Builder en

http://<host>:<port>/bin/querybuilder.json?path=/tmp

El path=/tmp es solo un ejemplo.

Depuración general de Recommendations general-debugging-recommendations

Obtener XPath explicable mediante el registro obtain-explain-able-xpath-via-logging

Explicar todo consultas durante el ciclo de desarrollo en el conjunto de índices de target.

  1. Habilite los registros DEBUG para que QueryBuilder obtenga una consulta XPath subyacente y explicable
    • Navegue hasta https://<host>:<port>/system/console/slinglog. Crear un registrador para com.day.cq.search.impl.builder.QueryImpl en DEPURAR.
  2. Después de habilitar DEBUG para la clase anterior, los registros muestran el XPath generado por el Generador de consultas.
  3. Copie la consulta XPath de la entrada de registro de la consulta asociada del Generador de consultas. Por ejemplo:
    • com.day.cq.search.impl.builder.QueryImpl XPath query: /jcr:root/content//element(*, cq:Page)[(jcr:contains(jcr:content, "WKND") or jcr:contains(jcr:content/@cq:tags, "WKND"))]
  4. Pegue la consulta XPath en Explicar consulta como XPath para poder obtener el plan de consulta.

Obtener XPath explicable mediante Query Builder Debugger obtain-explain-able-xpath-via-the-query-builder-debugger

AEM Use el depurador de Query Builder de la para generar una consulta XPath explicable.

Query Builder Debugger

  1. Proporcione la consulta del Generador de consultas en el depurador de Query Builder
  2. Ejecución de la búsqueda
  3. Obtener el XPath generado
  4. Pegue la consulta XPath en Explicar consulta como XPath para poder obtener el plan de consulta
NOTE
Las consultas que no son del Generador de consultas (XPath, JCR-SQL2) se pueden proporcionar directamente a Explicar consulta.

Depuración de consultas con registro debugging-queries-with-logging

NOTE
La configuración de los registradores se describe en el documento Registro.

Salida de registro (nivel INFO) de la implementación del generador de consultas al ejecutar la consulta descrita en la sección anterior Pruebas y depuración:

com.day.cq.search.impl.builder.QueryImpl executing query (predicate tree):
null=group: limit=20, offset=0[
    {group=group: or=true[
        {1_fulltext=fulltext: fulltext=WKND, relPath=jcr:content}
        {2_fulltext=fulltext: fulltext=WKND, relPath=jcr:content/@cq:tags}
    ]}
    {path=path: path=/content}
    {type=type: type=cq:Page}
]
com.day.cq.search.impl.builder.QueryImpl XPath query: /jcr:root/content//element(*, cq:Page)[(jcr:contains(jcr:content, "WKND") or jcr:contains(jcr:content/@cq:tags, "WKND"))]
com.day.cq.search.impl.builder.QueryImpl no filtering predicates
com.day.cq.search.impl.builder.QueryImpl query execution took 69 ms

Si tiene una consulta con evaluadores de predicado que filtran o que utilizan un orden personalizado por comparador, se indica en la consulta:

com.day.cq.search.impl.builder.QueryImpl executing query (predicate tree):
null=group: [
    {nodename=nodename: nodename=*.jar}
    {orderby=orderby: orderby=@jcr:content/jcr:lastModified}
    {type=type: type=nt:file}
]
com.day.cq.search.impl.builder.QueryImpl custom order by comparator: jcr:content/jcr:lastModified
com.day.cq.search.impl.builder.QueryImpl XPath query: //element(*, nt:file)
com.day.cq.search.impl.builder.QueryImpl filtering predicates: {nodename=nodename: nodename=*.jar}
com.day.cq.search.impl.builder.QueryImpl query execution took 272 ms
Javadoc
Descripción
com.day.cq.search
Generador de consultas básico y API de consultas
com.day.cq.search.result
API de resultados
com.day.cq.search.facets
Facetas
com.day.cq.search.facets.buckets
Contenedores (incluidos en las facetas)
com.day.cq.search.eval
Evaluadores de predicados
com.day.cq.search.facets.extrators
Extractores de facetas (para evaluadores)
com.day.cq.search.writer
Editor de visitas de resultados JSON para el servlet de Query Builder (/bin/querybuilder.json)
recommendation-more-help
fbcff2a9-b6fe-4574-b04a-21e75df764ab