Query Builder-API query-builder-api

De functionaliteit van de Bouwer van de Vraag van het Aandeel van Activawordt blootgesteld door Java™ API en een REST API. In deze sectie worden deze API's beschreven.

De server-zijvraagbouwer ( QueryBuilder) keurt een vraagbeschrijving goed, creeert en stelt een vraag van XPath in werking, naar keuze filter de resultaatreeks, en ook haalt facetten, indien gewenst.

De vraagbeschrijving is eenvoudig een reeks predikaten (Predicate). Voorbeelden zijn een voorspelling in volledige tekst, die overeenkomt met de functie jcr:contains() in XPath.

Voor elk predikaat type, is er een beoordelaarcomponent (PredicateEvaluator) die weet hoe te om dat specifieke predikaat voor XPath, het filtreren, en facetextractie te behandelen. Het is gemakkelijk om douanebeoordelaars tot stand te brengen, die door componenten OSGi runtime gestopt zijn.

De REST API biedt toegang tot dezelfde functies via HTTP, waarbij reacties worden verzonden in JSON.

Gem-sessie gem-session

Adobe Experience Manager (AEM) Gemsis een reeks technische diepe duiken in Adobe Experience Manager die door de deskundigen van de Adobe worden geleverd. Deze zitting die aan de vraagbouwer wordt gewijd is nuttig voor een overzicht en gebruik van het hulpmiddel.

Voorbeeldquery's sample-queries

Deze voorbeelden worden gegeven in de stijlnotatie van Java™-eigenschappen. Als u deze wilt gebruiken met de Java™ API, gebruikt u een Java™ HashMap zoals in het volgende API-voorbeeld.

Voor de QueryBuilder JSON-server bevat elk voorbeeld een koppeling naar uw lokale CQ-installatie (op de standaardlocatie, http://localhost:4502 ). Meld u aan bij uw CQ-exemplaar voordat u deze koppelingen gebruikt.

Alle resultaten retourneren returning-all-results

De volgende vraag keert tien resultaten terug (of, om precies te zijn, een maximum van tien), maar informeert u van het Aantal hits: die beschikbaar zijn:

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

De zelfde vraag (met de parameter p.limit=-1) zal alle resultaten terugkeren (dit zou een hoog aantal afhankelijk van uw instantie kunnen zijn):

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

De resultaten retourneren met p.radenTotal using-p-guesstotal-to-return-the-results

Het doel van de parameter p.guessTotal is om het juiste aantal resultaten te retourneren dat kan worden getoond door de minimale haalbare p.offset- en p.limit-waarden te combineren. Het voordeel van deze parameter is dat de prestaties van grote resultaatsets verbeterd zijn. Zo voorkomt u dat het volledige totaal wordt berekend (bijvoorbeeld door result.getSize() aan te roepen en de gehele resultaatset te lezen, volledig tot aan de Oak-engine en -index geoptimaliseerd. Dit kan een significant verschil zijn wanneer er 100 duizenden resultaten zijn, zowel in uitvoeringstijd als in geheugengebruik.

Het nadeel van de parameter is dat gebruikers het exacte totaal niet zien. Maar u kunt een minimumaantal zoals p.radenTotal=1000 plaatsen zodat zal het altijd tot 1000 lezen, zodat krijgt u nauwkeurige totalen voor kleinere resultaatreeksen, maar als het meer dan dat is, kunt u slechts "en meer"tonen.

Voeg p.guessTotal=true toe aan de onderstaande query om te zien hoe deze werkt:

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

De query retourneert de p.limit standaardwaarde van 10 resultaten met een 0 -verschuiving:

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

Vanaf AEM 6.0 SP2, kunt u een numerieke waarde ook gebruiken om tot een douanenummer van maximumresultaten te tellen. Gebruik dezelfde query als hierboven, maar wijzig de waarde van p.guessTotal in 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

Het keert een aantal de zelfde standaardgrens van tien resultaten met een 0 compensatie terug, maar zal slechts een maximum van 50 resultaten tonen:

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

Paginering uitvoeren implementing-pagination

Door gebrek zou de Bouwer van de Vraag ook het aantal treffers verstrekken. Afhankelijk van de resultaatgrootte, zou dit lange tijd kunnen vergen aangezien het bepalen van de nauwkeurige telling het controleren van elk resultaat voor toegangsbeheer impliceert. Meestal wordt het totaal gebruikt om paginering voor de eindgebruiker UI uit te voeren. Omdat het bepalen van de nauwkeurige telling langzaam kan zijn, wordt het geadviseerd om de gokTotal eigenschap te gebruiken om de paginering uit te voeren.

De interface kan bijvoorbeeld de volgende benadering aanpassen:

guessTotal moet worden gebruikt in gevallen waarin de gebruikersinterface oneindig schuiven moet gebruiken om te voorkomen dat de Query Builder het exacte aantal treffers bepaalt.

JAR-bestanden zoeken en deze bestellen, nieuwste eerst 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

Alle pagina's zoeken en bestellen op laatst gewijzigd 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

Alle pagina's zoeken en ze bestellen op laatst gewijzigd, maar aflopend 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

fullText-zoekopdracht, geordend op 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

Pagina's zoeken waaraan een bepaald label is toegekend 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

Gebruik tagid predikaat zoals in het voorbeeld als u expliciete markering ID kent.

Gebruik tag prepress voor de weg van de markeringstitel (zonder ruimten).

In het vorige voorbeeld, omdat u naar pagina's ( cq:Page knopen) zoekt, gebruik de relatieve weg van die knoop voor tagid.property predikaat, die jcr:content/cq:tags is. Standaard is de waarde van tagid.property cq:tags .

Zoeken onder meerdere paden (met groepen) 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

Deze vraag gebruikt a groep (genoemd " group"), die handelt om subexpressies binnen een vraag te afbakenen, veel zoals haakjes in meer standaardnota's doen. Bijvoorbeeld, zou de vorige vraag in een meer bekende stijl als kunnen worden uitgedrukt:

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

Binnen de groep in het voorbeeld wordt de voorspelling path meerdere keren gebruikt. Om de twee instanties van predikaat (het opdracht geven tot wordt vereist voor sommige predikaten) te onderscheiden en opdracht te geven, moet u predikaten met N _ whereN zijn het opdracht geven index. In het vorige voorbeeld zijn de resulterende voorspellingen 1_path en 2_path .

p in p.or is een speciaal afbakening erop wijst die dat wat volgt (in dit geval een or) a parameter van de groep, in tegenstelling tot een subpredikaat van de groep, zoals 1_path is.

Als er geen p.or wordt gegeven, zijn alle voorspellingen ANDed samen, dat wil zeggen, elk resultaat moet aan alle voorspellingen voldoen.

Zoeken naar eigenschappen search-for-properties

Hier zoekt u naar alle pagina's van een bepaalde sjabloon met de eigenschap 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

Dit heeft het nadeel dat de jcr:content knooppunten van de pagina's, niet de pagina's zelf, worden geretourneerd. U kunt dit oplossen door op relatief pad te zoeken:

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

Meerdere eigenschappen zoeken search-for-multiple-properties

Wanneer het gebruiken van het bezit voorspelt veelvoudige tijden, moet u de aantalprefixen opnieuw toevoegen:

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

Meerdere eigenschapswaarden zoeken search-for-multiple-property-values

Als u grote groepen wilt voorkomen wanneer u naar meerdere waarden van een eigenschap ( "A" or "B" or "C" ) wilt zoeken, kunt u meerdere waarden opgeven voor de voorspelling van 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

Voor eigenschappen met meerdere waarden kunt u ook vereisen dat meerdere waarden overeenkomen ( "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

Wat wordt geretourneerd, verfijnen refining-what-is-returned

Door gebrek, keert QueryBuilder JSON Servlet een standaardreeks eigenschappen voor elke knoop in het onderzoeksresultaat (bijvoorbeeld, weg, naam, en titel) terug. Als u de controle wilt verkrijgen over de eigenschappen die worden geretourneerd, kunt u een van de volgende handelingen uitvoeren:

Opgeven

p.hits=full

In dat geval worden alle eigenschappen opgenomen voor elk knooppunt:

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

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

Gebruiken

p.hits=selective

Geef de eigenschappen op die u wilt ophalen

p.properties

Gescheiden door een spatie:

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

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

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

Een ander ding u kunt doen is kindknopen in de reactie omvatten QueryBuilder. Hiervoor moet u opgeven

p.nodedepth=n

Waar n het aantal niveaus is dat u de vraag wilt terugkeren. Als een onderliggende node moet worden geretourneerd, moet deze worden opgegeven door de eigenschappenkiezer

p.hits=full

Voorbeeld:

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

Meer voorspellingen morepredicates

Voor meer predikaten, zie de Vooraf ingestelde pagina van de Verwijzing van de Bouwer van de Vraag.

U kunt Javadoc voor de PredicateEvaluator klassenook controleren. Javadoc voor deze klassen bevat de lijst met eigenschappen die u kunt gebruiken.

De prefix van de klassennaam (bijvoorbeeld, " similar"in SimilarityPredicateEvaluator) is het belangrijkste bezit van de klasse. Dit bezit is ook de naam van predikaat aan gebruik in de vraag (in kleine letters).

Voor dergelijke hoofdeigenschappen kunt u de query verkorten en " similar=/content/en" gebruiken in plaats van de volledig gekwalificeerde variant " similar.similar=/content/en". Het volledig gekwalificeerde formulier moet worden gebruikt voor alle niet-hoofdeigenschappen van een klasse.

Voorbeeld API-gebruik van 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 );
    }

Dezelfde query die via HTTP wordt uitgevoerd met de Query Builder (JSON) Servlet:

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

Vragen opslaan en laden storing-and-loading-queries

U kunt query's opslaan in de opslagplaats, zodat u ze later kunt gebruiken. In QueryBuilder wordt de methode "storeQuery voorzien van de volgende handtekening:

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

Wanneer u de methode QueryBuilder#storeQuerygebruikt, wordt de gegeven Query in de opslagplaats opgeslagen als een bestand of als een eigenschap volgens de argumentwaarde createFile . In het volgende voorbeeld wordt getoond hoe u een Query als bestand opslaat naar het pad /mypath/getfiles :

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

Om het even welke eerder opgeslagen vragen kunnen van de bewaarplaats worden geladen door de QueryBuilder#loadQuerymethode te gebruiken:

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

Een Query opgeslagen naar het pad /mypath/getfiles kan bijvoorbeeld door het volgende fragment worden geladen:

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

Testen en fouten opsporen testing-and-debugging

Voor het spelen rond en het zuiveren querybuilder vragen, kunt u de debugger console gebruiken QueryBuilder bij

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

Of anders de querybuilder json servlet bij

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

( path=/tmp is slechts een voorbeeld).

Algemene foutopsporing in Recommendations general-debugging-recommendations

Leg XPath voor uitleg beschikbaar via logboekregistratie obtain-explain-able-xpath-via-logging

Verklaar alle vragen tijdens de ontwikkelingscyclus tegen de reeks van de doelindex.

Vraag verklaarbare XPath via debugger van de Bouwer van de Vraag obtain-explain-able-xpath-via-the-query-builder-debugger

Verklaar alle vragen tijdens de ontwikkelingscyclus tegen de reeks van de doelindex.

verkrijg verklaring-able XPath via registreren

verkrijg verklaring-able XPath via debugger van de Bouwer van de Vraag

Voor rundown op hoe te om vragen met QueryBuilder te zuiveren, zie de video hieronder.

Foutopsporing in query's met logboekregistratie debugging-queries-with-logging

De logboekoutput (niveau INFO) van de implementatie van de vraagbouwer wanneer het uitvoeren van de vraag die in het Testen en het Zuiveren wordt beschreven:

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

Als u een vraag gebruikend predikaat beoordelaars hebt die filter of die een douaneorde door comparator gebruiken, zal dit ook in de vraag worden vermeld:

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-koppelingen javadoc-links