Bästa praxis för frågor och indexering query-and-indexing-best-practices

I AEM as a Cloud Service automatiseras alla operativa aspekter av indexering. Detta gör att utvecklare kan fokusera på att skapa effektiva frågor och motsvarande indexdefinitioner.

När frågor ska användas when-to-use-queries

Frågor är ett sätt att komma åt innehåll, men är inte den enda möjligheten. I många situationer kan innehåll i databasen nås mer effektivt på andra sätt. Du bör tänka på om frågor är det bästa och mest effektiva sättet att komma åt innehåll för ditt användningssätt.

Databas- och taxonomidesign repository-and-taxonomy-design

När du utformar taxonomin för en databas måste flera faktorer beaktas. Dessa omfattar åtkomstkontroller, lokalisering, komponent- och sidegenskapsarv med mera.

När du utformar en taxonomi som tar upp dessa problem är det också viktigt att tänka på hur"genomskinlighet" är i indexdesignen. I det här sammanhanget är möjligheten att gå igenom en taxonomi att göra det möjligt för innehåll att nås på ett förutsägbart sätt baserat på dess sökväg. Detta gör att du får ett mer effektivt system som är enklare att underhålla än ett som kräver att flera frågor ska köras.

När du utformar en taxonomi är det dessutom viktigt att tänka på om det är viktigt att beställa. I de fall där explicit ordning inte krävs och ett stort antal noder på samma nivå förväntas, är det att föredra att använda en oordnad nodtyp som sling:Folder eller oak:Unstructured. I de fall där beställning krävs är nt:unstructured och sling:OrderedFolder lämpligare.

Frågor i komponenter queries-in-components

Eftersom frågor kan vara en av de mer beskattningsbara åtgärder som utförs i ett AEM är det en bra idé att undvika dem i dina komponenter. Om flera frågor körs varje gång en sida återges kan det ofta försämra systemets prestanda. Det finns två strategier som kan användas för att undvika att köra frågor vid återgivning av komponenter: gå igenom noder och förhämta resultat.

Går igenom noder traversing-nodes

Om databasen är utformad på ett sätt som möjliggör tidigare kunskap om platsen för de data som krävs, kan kod som hämtar dessa data från de nödvändiga sökvägarna distribueras utan att behöva köra frågor för att hitta dem.

Ett exempel på detta är att återge innehåll som passar inom en viss kategori. Ett sätt är att ordna innehållet med en kategoriegenskap som kan efterfrågas för att fylla i en komponent som visar objekt i en kategori.

Ett bättre sätt är att strukturera innehållet i en taxonomi efter kategori så att det kan hämtas manuellt.

Om innehållet till exempel lagras i en taxonomi som liknar:

/content/myUnstructuredContent/parentCategory/childCategory/contentPiece

noden /content/myUnstructuredContent/parentCategory/childCategory kan bara hämtas, dess underordnade noder kan tolkas och användas för att återge komponenten.

När du har att göra med en liten eller homogen resultatuppsättning kan det dessutom vara snabbare att gå igenom databasen och samla ihop de noder som behövs, i stället för att skapa en fråga som returnerar samma resultatmängd. Generellt sett bör frågor undvikas där det är möjligt att göra detta.

Förhämtningsresultat prefetching-results

Ibland tillåter inte innehållet eller kraven runt komponenten att nodgenomgång används som ett sätt att hämta nödvändiga data. I sådana fall måste de nödvändiga frågorna köras innan komponenten återges, så att optimala prestanda säkerställs.

Om de resultat som krävs för komponenten kan beräknas när den redigeras och det inte finns någon förväntad tid för att innehållet ska ändras, kan frågan köras när en ändring har gjorts.

Om data eller innehåll ändras regelbundet, kan frågan köras enligt ett schema eller via en avlyssnare för uppdateringar av underliggande data. Sedan kan resultaten skrivas till en delad plats i databasen. Alla komponenter som behöver dessa data kan sedan hämta värden från den här noden utan att behöva köra en fråga vid körning.

En liknande strategi kan användas för att behålla resultatet i en minnescache, som fylls i vid start och uppdateras när ändringar görs (med en JCR ObservationListener eller en Sling ResourceChangeListener).

Optimera frågor optimizing-queries

I Oak-dokumentationen finns en översikt över hur frågor körs. Detta utgör grunden för alla optimeringsaktiviteter som beskrivs i det här dokumentet.

AEM as a Cloud Service tillhandahåller frågeprestandaverktyget som är utformat för att ge stöd åt implementering av effektiva frågor.

Det går att nå frågeprestandaverktyget via Developer Console i Cloud Manager. AEM as a Cloud Service Query Performance Tool innehåller mer information om frågekörningen jämfört med AEM 6.x-versionen.

I det här diagrammet visas det allmänna flödet för att använda verktyget Frågeprestanda för att optimera frågor.

Använd ett index use-an-index

Alla frågor bör använda ett index för att ge optimala prestanda. I de flesta fall bör befintliga färdiga index vara tillräckliga för att hantera frågor.

Ibland måste anpassade egenskaper läggas till i ett befintligt index, så att ytterligare begränsningar kan efterfrågas med hjälp av indexet. Mer information finns i dokumentet Innehållssökning och indexering. Avsnittet JCR-frågekarta i det här dokumentet beskriver hur en egenskapsdefinition i ett index måste se ut att ha stöd för en viss frågetyp.

Använd rätt villkor use-the-right-criteria

Den primära begränsningen för en fråga bör vara en egenskapsmatchning, eftersom detta är den mest effektiva typen. Om du lägger till fler egenskapsbegränsningar begränsas resultatet ytterligare.

Frågemotorn hanterar bara ett enda index. Det innebär att ett befintligt index kan och bör anpassas genom att fler anpassade indexegenskaper läggs till i det.

I JCR-frågans-mallavsnitt i det här dokumentet visas tillgängliga begränsningar och även hur en indexdefinition måste se ut så att den plockas upp. Använd frågeprestandaverktyget för att testa frågan och kontrollera att rätt index används och att frågemotorn inte behöver utvärdera begränsningar utanför indexet.

Beställning ordering

Om en viss resultatordning begärs, finns det två sätt för frågemotorn att uppnå detta:

Begränsa resultatstorleken restrict-result-size

Den hämtade storleken på frågeresultatet är en viktig faktor för frågeprestanda. Eftersom resultatet hämtas på ett lat sätt är det skillnad på att bara hämta de första 20 resultaten jämfört med att hämta 10 000 resultat, både i körtid och minnesanvändning.

Det innebär också att storleken på resultatmängden bara kan bestämmas korrekt om alla resultat hämtas. Därför bör den hämtade resultatuppsättningen alltid begränsas, antingen genom att frågan utökas (mer information finns i JCR-frågans-avsnitt i det här dokumentet) eller genom att resultatens läsningar begränsas.

En sådan gräns förhindrar även att frågemotorn hissar på traversal-gränsen på 100 000 noder, vilket leder till ett framtvingat stopp av frågan.

Se avsnittet Frågor med stora resultatuppsättningar i det här dokumentet om en potentiellt stor resultatuppsättning måste bearbetas fullständigt.

Prestandaverktyg för fråga query-performance-tool

Prestandaverktyget för frågor (finns på /libs/granite/operations/content/diagnosistools/queryPerformance.html och är tillgängligt via Developer Console i Cloud Manager) innehåller -

Tabellerna"Långsvisa frågor" och"Populära frågor" innehåller -

De här tabellerna hjälper till att identifiera frågor som inte är helt indexerade (se Använd ett index eller läser för många noder (se även Databasgenomgång och Indexgenomgång). Sådana frågor kommer att markeras med rött.

Alternativet Reset Statistics har angetts för att ta bort all befintlig statistik som samlats in i tabellerna. Detta gör att en viss fråga kan köras (antingen via själva programmet eller verktyget Förklara fråga) och att körningsstatistiken analyseras.

Förklara fråga

Med verktyget Förklara fråga kan utvecklare förstå frågekörningsplanen (se Läsa frågekörningsplanen), inklusive information om eventuella index som används när frågan körs. Detta kan användas för att förstå hur effektivt en fråga indexeras för att förutsäga eller retroaktivt analysera dess prestanda.

Förklara en fråga

Så här förklarar du en fråga:

Popup-fönstret Frågeförklaring query-explanation-popup

När användaren har valt Explain visas ett popup-fönster som beskriver resultatet av frågeförklaringen (och körningen, om det är markerat).
Det här popup-fönstret innehåller information om

Läsa frågekörningsplanen reading-query-execution-plan

Frågekörningsplanen innehåller allt som krävs för att förutsäga (eller förklara) prestanda för en viss fråga. Förstå hur effektivt frågan kommer att köras genom att jämföra begränsningarna och ordningen i den ursprungliga JCR-frågan (eller Query Builder) med frågan som körs i det underliggande indexet (Lucene, Elastic eller Property).

Tänk på följande fråga -

/jcr:root/content/dam//element(*, dam:Asset) [jcr:content/metadata/dc:title = "My Title"] order by jcr:created

…som innehåller -

Förklaring av frågeresultatet i följande plan -

[dam:Asset] as [a] /* lucene:damAssetLucene-9(/oak:index/damAssetLucene-9) +:ancestors:/content/dam +jcr:content/metadata/dc:title:My Title ordering:[{ propertyName : jcr:created, propertyType : UNDEFINED, order : ASCENDING }] where ([a].[jcr:content/metadata/dc:title] = 'My Title') and (isdescendantnode([a], [/content/dam])) */

I den här planen är avsnittet som beskriver frågan som körs i det underliggande indexet -

lucene:damAssetLucene-9(/oak:index/damAssetLucene-9) +:ancestors:/content/dam +jcr:content/metadata/dc:title:My Title ordering:[{ propertyName : jcr:created, propertyType : UNDEFINED, order : ASCENDING }]

I det här avsnittet av planen anges att

En sådan fråga kommer förmodligen att fungera bra, eftersom resultaten som returneras från indexfrågan inte kommer att filtreras ytterligare i frågemotorn (utöver åtkomstkontrollsfiltrering). Det är dock fortfarande möjligt att en sådan fråga körs långsamt om bästa praxis inte följs - se Indexgenomgång nedan.

En annan fråga övervägs -

/jcr:root/content/dam//element(*, dam:Asset) [jcr:content/metadata/myProperty = "My Property Value"] order by jcr:created

…som innehåller -

Förklaring av frågeresultatet i följande plan -

[dam:Asset] as [a] /* lucene:damAssetLucene-9-custom-1(/oak:index/damAssetLucene-9-custom-1) :ancestors:/content/dam ordering:[{ propertyName : jcr:created, propertyType : UNDEFINED, order : ASCENDING }] where ([a].[jcr:content/metadata/myProperty] = 'My Property Value') and (isdescendantnode([a], [/content/dam])) */

I den här planen är avsnittet som beskriver frågan som körs i det underliggande indexet -

lucene:damAssetLucene-9(/oak:index/damAssetLucene-9) :ancestors:/content/dam ordering:[{ propertyName : jcr:created, propertyType : UNDEFINED, order : ASCENDING }]

I det här avsnittet av planen anges att

Den här frågekörningsplanen resulterar i att alla resurser under /content/dam läses från indexet och sedan filtreras ytterligare av frågemotorn (som endast inkluderar de som matchar den icke-indexerade egenskapsbegränsningen i resultatuppsättningen).

Även om bara en liten procentandel av resurserna matchar begränsningen jcr:content/metadata/myProperty = "My Property Value" måste frågan läsa ett stort antal noder för att (försöka) fylla den begärda sidan med resultat. Detta kan resultera i en fråga som inte fungerar som den ska, vilket visas som ett lågt Read Optimization-resultat i verktyget Frågeprestanda) och kan leda till WARN-meddelanden som anger att ett stort antal noder gås igenom (se Indexgenomgång).

Om du vill optimera prestandan för den andra frågan skapar du en anpassad version av damAssetLucene-9-indexet (damAssetLucene-9-custom-1) och lägger till följande egenskapsdefinition -

"myProperty": {
  "jcr:primaryType": "nt:unstructured",
  "propertyIndex": true,
  "name": "jcr:content/metadata/myProperty"
}

JCR Query Cheat Sheet jcr-query-cheatsheet

JCR-frågechebladet kan hämtas och användas som referens under utvecklingen, vilket ger stöd för att skapa effektiva JCR-frågor och indexdefinitioner.

Den innehåller exempelfrågor för QueryBuilder, XPath och SQL-2, som omfattar flera scenarier som beter sig på olika sätt när det gäller frågeprestanda. Här finns också rekommendationer för hur du skapar eller anpassar Oak-index. Innehållet i detta värmeblad gäller AEM as a Cloud Service och AEM 6.5.

Metodtips för indexdefinitioner index-definition-best-practices

Nedan följer några tips som du bör tänka på när du definierar eller utökar index.

Automatiserade Cloud Manager pipeline-kontroller kommer att implementera några av de bästa metoderna som beskrivs ovan.

Frågor med stora resultatuppsättningar queries-with-large-result-sets

Du bör undvika frågor med stora resultatuppsättningar, men det finns giltiga fall där stora resultatuppsättningar måste bearbetas. Resultatstorleken är ofta inte känd framifrån, och därför bör vissa försiktighetsåtgärder vidtas för att göra bearbetningen tillförlitlig.

Databasgenomgång repository-traversal

Frågor som går igenom databasen använder inget index och loggar med ett meddelande som liknar det nedan.

28.06.2022 13:32:52.804 *WARN* [127.0.0.1 [1656415972414] POST /libs/settings/granite/operations/diagnosis/granite_queryperformance.explain.json HTTP/1.1] org.apache.jackrabbit.oak.plugins.index.Cursors$TraversingCursor Traversed 98000 nodes with filter Filter(query=select [jcr:path], [jcr:score], * from [nt:base] as a /* xpath: //* */, path=*) called by com.adobe.granite.queries.impl.explain.query.ExplainQueryServlet.getHeuristics; consider creating an index or changing the query

Med det här loggfragmentet kan du bestämma:

Med den här informationen är det möjligt att optimera frågan med metoderna som beskrivs i avsnittet Optimera frågor i det här dokumentet.

Indexgenomgång index-traversal

Frågor som använder ett index, men ändå läser stora antal noder, loggas med ett meddelande som liknar följande (observera termen Index-Traversed i stället för Traversed).

05.10.2023 10:56:10.498 *WARN* [127.0.0.1 [1696502982443] POST /libs/settings/granite/operations/diagnosis/granite_queryperformance.explain.json HTTP/1.1] org.apache.jackrabbit.oak.plugins.index.search.spi.query.FulltextIndex$FulltextPathCursor Index-Traversed 60000 nodes with filter Filter(query=select [jcr:path], [jcr:score], * from [dam:Asset] as a where isdescendantnode(a, '/content/dam') order by [jcr:content/metadata/unindexedProperty] /* xpath: /jcr:root/content/dam//element(*, dam:Asset) order by jcr:content/metadata/unindexedProperty */, path=/content/dam//*)

Detta kan inträffa av flera orsaker -