API Query Builder query-builder-api

La fonctionnalité du générateur de requêtes de partage de ressources est exposée via une API Java™ et une API REST. Cette section décrit ces API.

Le générateur de requêtes côté serveur (QueryBuilder) accepte une description de requête, crée et exécute une requête XPath, peut filtrer le jeu de résultats et, si vous le souhaitez, extrait également des facettes.

La description de requête correspond simplement à un ensemble de prédicats (Predicate). Par exemple, un prédicat de texte intégral correspond à la fonction jcr:contains() dans XPath.

Pour chaque type de prédicat, il existe un composant Évaluateur (PredicateEvaluator) qui sait comment en effectuer la gestion pour XPath, pour le filtrage et pour l’extraction de facettes. Il est facile de créer des évaluateurs personnalisés, qui sont connectés via l’exécution du composant OSGi.

L’API REST permet d’accéder aux mêmes fonctionnalités via HTTP avec les réponses envoyées dans JSON.

Session Gem gem-session

Adobe Experience Manager (AEM) Gems est une série de sessions techniques approfondies sur Adobe Experience Manager, dispensées par des experts Adobe. Cette session dédiée au générateur de requêtes permet d’obtenir une vue d’ensemble de l’outil et de son utilisation.

Exemples de requêtes sample-queries

Ces exemples sont fournis dans la notation de style des propriétés Java™. Pour les utiliser avec l’API Java™, utilisez une HashMap Java™ comme dans l’exemple d’API suivant.

Pour le servlet JSON QueryBuilder, chaque exemple comprend un lien vers votre installation CQ locale (à l’emplacement par défaut, http://localhost:4502). Connectez-vous à votre instance CQ avant d’utiliser ces liens.

Renvoi de tous les résultats returning-all-results

La requête suivante renvoie dix résultats (plus précisément, un maximum de dix résultats), mais vous informe du Nombre d’accès disponibles :

http://localhost:4502/bin/querybuilder.json?path=/content&1_property=sling:resourceType&1_property.value=foundation/components/text&1_property.operation=like&orderby=path

path=/content
1_property=sling:resourceType
1_property.value=foundation/components/text
1_property.operation=like
orderby=path

La même requête (avec le paramètre p.limit=-1) renvoie tous les résultats (il peut s’agir d’un nombre élevé en fonction de votre instance) :

http://localhost:4502/bin/querybuilder.json?path=/content&1_property=sling:resourceType&1_property.value=foundation/components/text&1_property.operation=like&p.limit=-1&orderby=path

path=/content
1_property=sling:resourceType
1_property.value=foundation/components/text
1_property.operation=like
p.limit=-1
orderby=path

Utilisation de p.guessTotal pour renvoyer les résultats using-p-guesstotal-to-return-the-results

L’objectif du paramètre p.guessTotal est de renvoyer le nombre approprié de résultats pouvant être affichés en combinant les plus petites valeurs p.offset et p.limit possibles. Utilisé avec des jeux de résultats de grande taille, ce paramètre offre des performances encore meilleures. Cela vous évite de calculer le total (en appelant resul.getSize(), par exemple) et de lire l’ensemble du jeu de résultats, optimisé jusqu’à l’index et au moteur Oak. Cela peut faire une grande différence lorsqu’il y a des centaines de milliers de résultats, tant sur le plan de la durée d’exécution que de l’utilisation de la mémoire.

L’inconvénient de ce paramètre est que les utilisateurs ne voient pas le total exact. Vous pouvez toutefois définir un nombre minimal, telle que p.guessTotal=1000, de sorte que la lecture soit toujours effectuée jusqu’à 1 000. Vous obtiendrez ainsi des totaux exacts pour des jeux de résultats plus petits. En revanche, pour des jeux de résultats plus grands, vous pouvez simplement afficher « et plus ».

Ajoutez p.guessTotal=true à la requête ci-dessous pour voir comment cela fonctionne :

http://localhost:4502/bin/querybuilder.json?path=/content&1_property=sling:resourceType&1_property.value=foundation/components/text&1_property.operation=like&p.guessTotal=true&orderby=path

path=/content
1_property=sling:resourceType
1_property.value=foundation/components/text
1_property.operation=like
p.guessTotal=true
orderby=path

La requête renvoie la valeur p.limit par défaut de 10 résultats avec un décalage de 0 :

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

Depuis AEM 6.0 SP2, vous pouvez également utiliser une valeur numérique pour compter jusqu’à un nombre personnalisé de résultats maximums. Utilisez la même requête que ci-dessus, mais définissez la valeur de p.guessTotal sur 50 :

http://localhost:4502/bin/querybuilder.json?path=/content&1_property=sling:resourceType&1_property.value=foundation/components/text&1_property.operation=like&p.guessTotal=50&orderby=path

Elle renvoie un nombre correspondant à la limite par défaut de 10 résultats avec un décalage de 0, mais n’affiche que 50 résultats maximum :

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

Mise en œuvre de la pagination implementing-pagination

Par défaut, Query Builder fournit également le nombre d’accès. En fonction de la taille du résultat, cela peut prendre un certain temps, car déterminer le nombre exact implique de vérifier le contrôle d’accès de chaque résultat. Le total est principalement utilisé pour implémenter la pagination pour l’interface utilisateur de la personne utilisatrice finale. Comme la détermination du nombre exact peut être lente, nous recommandons d’utiliser la fonction guessTotal pour mettre en œuvre la pagination.

Par exemple, l’interface utilisateur peut adapter l’approche suivante :

Il est conseillé d’utiliser guessTotal lorsque l’interface utilisateur doit appliquer un défilement infini, afin d’empêcher le Query Builder de déterminer le nombre exact d’accès.

Recherche et classement des fichiers JAR, en commençant par le plus récent find-jar-files-and-order-them-newest-first

http://localhost:4502/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

Recherche de toutes les pages et classement par date de la dernière modification find-all-pages-and-order-them-by-last-modified

http://localhost:4502/bin/querybuilder.json?type=cq:Page&orderby=@jcr:content/cq:lastModified

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

Recherche de toutes les pages et classement par date de la dernière modification, mais par ordre décroissant find-all-pages-and-order-them-by-last-modified-but-descending

http://localhost:4502/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

Recherche en texte intégral, avec classement par score fulltext-search-ordered-by-score

http://localhost:4502/bin/querybuilder.json?fulltext=Management&orderby=@jcr:score&orderby.sort=desc

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

Recherche des pages présentant une balise donnée search-for-pages-tagged-with-a-certain-tag

http://localhost:4502/bin/querybuilder.json?type=cq:Page&tagid=marketing:interest/product&tagid.property=jcr:content/cq:tags

type=cq:Page
tagid=marketing:interest/product
tagid.property=jcr:content/cq:tags

Utilisez le prédicat tagid, comme dans l’exemple, si vous connaissez l’ID de balise explicite.

Utilisez le prédicat tag pour le chemin d’accès au titre de la balise (sans espaces).

Comme vous recherchiez des pages dans l’exemple précédent (nœuds cq:Page), utilisez le chemin d’accès relatif à partir de ce nœud pour le prédicat tagid.property, à savoir jcr:content/cq:tags. Par défaut, le prédicat tagid.property est simplement cq:tags.

Recherche dans plusieurs chemins d’accès (à l’aide de groupes) search-under-multiple-paths-using-groups

http://localhost:4502/bin/querybuilder.json?fulltext=Management&group.1_path=/content/geometrixx/en/company/management&group.2_path=/content/geometrixx/en/company/bod&group.p.or=true

fulltext=Management
group.p.or=true
group.1_path=/content/geometrixx/en/company/management
group.2_path=/content/geometrixx/en/company/bod

Cette requête utilise un groupe (appelé « group »), qui sert à délimiter les sous-expressions dans une requête, à l’instar des parenthèses dans des notations plus standard. Par exemple, la requête précédente peut être exprimée dans un style plus familier comme suit :

"Management" and ("/content/geometrixx/en/company/management" or "/content/geometrixx/en/company/bod")

Le prédicat path est utilisé à plusieurs reprises dans le groupe de l’exemple précédent. Pour différencier et classer les deux instances du prédicat (un classement est requis pour certains prédicats), vous devez faire précéder les prédicats de N où _ whereN est l’index de classement. Dans l’exemple précédent, les prédicats obtenus sont 1_path et 2_path.

Le p dans p.or est un délimiteur spécial qui indique que ce qui suit (dans ce cas, or) est un paramètre du groupe, par opposition à un sous-prédicat du groupe, tel que 1_path.

Si aucun p.or n’est indiqué, tous les prédicats sont associés avec AND ; en d’autres termes, chaque résultat doit répondre à l’ensemble des prédicats.

Recherche de propriétés search-for-properties

Dans ce cas, vous recherchez toutes les pages d’un modèle donné, à l’aide de la propriété cq:template :

http://localhost:4502/bin/querybuilder.json?property=cq%3atemplate&property.value=%2fapps%2fgeometrixx%2ftemplates%2fhomepage&type=cq%3aPageContent

type=cq:PageContent
property=cq:template
property.value=/apps/geometrixx/templates/homepage

L’inconvénient est que les nœuds jcr:content des pages sont renvoyés, et non les pages proprement dites. Pour remédier à ce problème, vous pouvez effectuer une recherche par chemin d’accès relatif :

http://localhost:4502/bin/querybuilder.json?property=jcr%3acontent%2fcq%3atemplate&property.value=%2fapps%2fgeometrixx%2ftemplates%2fhomepage&type=cq%3aPage

type=cq:Page
property=jcr:content/cq:template
property.value=/apps/geometrixx/templates/homepage

Recherche de plusieurs propriétés search-for-multiple-properties

Lorsque vous utilisez plusieurs fois le prédicat property, vous devez ajouter à nouveau les préfixes numériques :

http://localhost:4502/bin/querybuilder.json?1_property=jcr%3acontent%2fcq%3atemplate&1_property.value=%2fapps%2fgeometrixx%2ftemplates%2fhomepage&2_property=jcr%3acontent%2fjcr%3atitle&2_property.value=English&type=cq%3aPage

type=cq:Page
1_property=jcr:content/cq:template
1_property.value=/apps/geometrixx/templates/homepage
2_property=jcr:content/jcr:title
2_property.value=English

Recherche de plusieurs valeurs de propriété search-for-multiple-property-values

Pour éviter la constitution de groupes volumineux lorsque vous souhaitez rechercher plusieurs valeurs d’une propriété ("A" or "B" or "C"), vous pouvez fournir plusieurs valeurs au prédicat property :

http://localhost:4502/bin/querybuilder.json?property=jcr%3atitle&property.1_value=Products&property.2_value=Square&property.3_value=Events

property=jcr:title
property.1_value=Products
property.2_value=Square
property.3_value=Events

Pour les propriétés à plusieurs valeurs, vous pouvez également exiger que plusieurs valeurs correspondent ("A" and "B" and "C") :

http://localhost:4502/bin/querybuilder.json?property=jcr%3atitle&property.and=true&property.1_value=test&property.2_value=foo&property.3_value=bar

property=jcr:title
property.and=true
property.1_value=test
property.2_value=foo
property.3_value=bar

Amélioration des propriétés renvoyées refining-what-is-returned

Par défaut, le servlet JSON QueryBuilder renvoie un jeu de propriétés par défaut pour chaque nœud dans les résultats de recherche (par exemple, chemin d’accès, nom et titre). Pour contrôler les propriétés renvoyées, vous pouvez effectuer l’une des opérations suivantes :

Spécifiez

p.hits=full

Dans ce cas, toutes les propriétés sont incluses pour chaque nœud :

http://localhost:4502/bin/querybuilder.json?p.hits=full&property=jcr%3atitle&property.value=Triangle

property=jcr:title
property.value=Triangle
p.hits=full

Utilisez

p.hits=selective

Et spécifiez les propriétés à intégrer

p.properties

Séparées par un espace :

http://localhost:4502/bin/querybuilder.json?p.hits=selective&property=jcr%3atitle&property.value=Triangle

http://localhost:4502/bin/querybuilder.json? p.hits=selective&p.properties=sling%3aresourceType%20jcr%3aprimaryType&property=jcr%3atitle&property.value=Triangle

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

Vous pouvez également inclure des nœuds enfants dans la réponse de QueryBuilder. Pour cela, vous devez spécifier :

p.nodedepth=n

Où n correspond au nombre de niveaux que la requête doit renvoyer. Pour qu’un nœud enfant soit renvoyé, il doit être spécifié par le sélecteur de propriétés

p.hits=full

Exemple :

http://localhost:4502/bin/querybuilder.json?p.hits=full&p.nodedepth=5&property=jcr%3atitle&property.value=Triangle

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

Plus de prédicats morepredicates

Pour plus de prédicats, consultez la page de référence des prédicats de Query Builder.

Vous pouvez également consulter le JavaDoc relatif aux PredicateEvaluatorclasses. Ce JavaDoc contient la liste des propriétés que vous pouvez utiliser.

Le préfixe du nom de classe (par exemple, « similar » dans SimilarityPredicateEvaluator), est la propriété principale de la classe. Cette propriété est également le nom du prédicat à utiliser dans la requête (en minuscules).

Pour ces propriétés principales, vous pouvez raccourcir la requête et utiliser similar=/content/en au lieu de la variante complète « similar.similar=/content/en ». La forme complète doit être utilisée pour toutes les propriétés non principales d’une classe.

Exemple d’utilisation de l’API Query Builder example-query-builder-api-usage

   String fulltextSearchTerm = "Geometrixx";

    // 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 même requête exécutée sur HTTP à l’aide du servlet Query Builder (JSON) :

http://localhost:4502/bin/querybuilder.json?path=/content&type=cq:Page&group.p.or=true&group.1_fulltext=Geometrixx&group.1_fulltext.relPath=jcr:content&group.2_fulltext=Geometrixx&group.2_fulltext.relPath=jcr:content/@cq:tags&p.offset=0&p.limit=20

Stockage et chargement de requêtes storing-and-loading-queries

Les requêtes peuvent être stockées dans le référentiel de manière à pouvoir les utiliser ultérieurement. QueryBuilder fournit la méthode storeQuery avec la signature suivante :

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

Si vous utilisez la méthode QueryBuilder#storeQuery, la Query donnée est stockée dans le référentiel sous la forme d’un fichier ou d’une propriété suivant la valeur de l’argument createFile. L’exemple suivant illustre l’enregistrement d’une Query sous /mypath/getfiles en tant que fichier :

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

Toutes les requêtes stockées précédemment peuvent être chargées à partir du référentiel en utilisant la méthode QueryBuilder#loadQuery :

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

Par exemple, une Query stockée sous /mypath/getfiles peut être chargée par l’extrait de code suivant :

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

Tests et débogage testing-and-debugging

Pour vous entraîner et déboguer des requêtes QueryBuilder, vous pouvez utiliser la console de débogage QueryBuilder à l’adresse suivante :

http://localhost:4502/libs/cq/search/content/querydebug.html

Une autre solution consiste à utiliser le servlet JSON QueryBuilder à l’adresse suivante :

http://localhost:4502/bin/querybuilder.json?path=/tmp

(path=/tmp est donné uniquement à titre d’exemple).

Recommandations générales en matière de débogage general-debugging-recommendations

Obtention d’une requête XPath explicable par le biais de la journalisation obtain-explain-able-xpath-via-logging

Expliquez toutes les requêtes au cours du cycle de développement par rapport à l’ensemble d’index cible.

Obtention d’une requête XPath explicable par le biais du débogueur QueryBuilder obtain-explain-able-xpath-via-the-query-builder-debugger

Expliquez toutes les requêtes au cours du cycle de développement par rapport à l’ensemble d’index cible.

Obtention d’une requête XPath explicable par le biais de la journalisation

Obtention d’une requête XPath explicable par le biais du débogueur QueryBuilder

Pour avoir un aperçu de la procédure de débogage des requêtes avec QueryBuilder, regardez la vidéo ci-dessous.

Débogage de requêtes à l’aide de la journalisation debugging-queries-with-logging

Sortie de journal (niveau INFO) de la mise en œuvre du générateur de requêtes lors de l’exécution de la requête décrite dans Tests et débogage :

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=Geometrixx, relPath=jcr:content}
        {2_fulltext=fulltext: fulltext=Geometrixx, 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, "Geometrixx") or jcr:contains(jcr:content/@cq:tags, "Geometrixx"))]
com.day.cq.search.impl.builder.QueryImpl no filtering predicates
com.day.cq.search.impl.builder.QueryImpl query execution took 69 ms

Dans le cas d’une requête qui utilise des évaluateurs de prédicats qui filtrent ou appliquent un ordre personnalisé par comparateur, cela est également indiqué dans la requête :

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

Liens JavaDoc javadoc-links