Query e indicizzazione Oak

Introduzione

A differenza di Jackrabbit 2, Oak non indicizza il contenuto per impostazione predefinita. Gli indici personalizzati devono essere creati quando necessario, come con i database relazionali tradizionali. Se non esiste un indice per una query specifica, è possibile che vengano attraversati molti nodi. La query potrebbe ancora funzionare, ma è probabilmente lenta.

Se Oak rileva una query senza un indice, viene stampato un messaggio di registro di livello WARN:

*WARN* Traversed 1000 nodes with filter Filter(query=select ...) consider creating an index or changing the query

Lingue di query supportate

Il motore di query Oak supporta i seguenti linguaggi:

• XPath (consigliato)
• SQL-2
• SQL (obsoleto)
• JQOM

Tipi di indicizzatore e calcolo dei costi

Il backend basato su Apache Oak consente di collegare diversi indicizzatori all’archivio.

Un indicizzatore è Indice proprietà, per il quale la definizione dell’indice è memorizzata nell’archivio stesso.

Implementazioni per Apache Lucene e Solr sono inoltre disponibili per impostazione predefinita, entrambe supportano l’indicizzazione full-text.

Il Indice trasversale viene utilizzato se non è disponibile alcun altro indicizzatore. Ciò significa che il contenuto non è indicizzato e che i nodi di contenuto vengono attraversati per trovare corrispondenze alla query.

Se per una query sono disponibili più indicizzatori, ogni indicizzatore disponibile stima il costo dell'esecuzione della query. Oak sceglie quindi l'indicizzatore con il costo stimato più basso.

Il diagramma precedente è una rappresentazione di alto livello del meccanismo di esecuzione delle query di Apache Oak.

Innanzitutto, la query viene analizzata in una struttura ad albero della sintassi astratta. Quindi, la query viene controllata e trasformata in SQL-2, che è la lingua nativa per le query Oak.

Successivamente, ogni indice viene consultato per stimare il costo della query. Una volta completato, vengono recuperati i risultati dall’indice più economico. Infine, i risultati vengono filtrati, sia per garantire che l’utente corrente abbia accesso in lettura al risultato sia che il risultato corrisponda alla query completa.

Configurazione degli indici

Se la reindicizzazione è necessaria in archivi di grandi dimensioni, specialmente quando si utilizza MongoDB e per gli indici full-text, considera la pre-estrazione del testo e l’utilizzo di oak-run per creare l’indice iniziale e reindicizzare.

Gli indici sono configurati come nodi nell’archivio sotto Oak:indice nodo.

Il tipo del nodo dell’indice deve essere oak:QueryIndexDefinition. Sono disponibili diverse opzioni di configurazione per ogni indicizzatore come proprietà del nodo. Per ulteriori informazioni, consulta i dettagli di configurazione per ogni tipo di indicizzatore riportati di seguito.

Indice proprietà

L'indice delle proprietà è utile per le query che hanno vincoli di proprietà ma non sono full-text. Può essere configurato seguendo la procedura seguente:

1. Apri CRXDE da http://localhost:4502/crx/de/index.jsp

2. Crea un nodo sotto oak:index

3. Denomina il nodo PropertyIndex, e impostare il tipo di nodo su oak:QueryIndexDefinition

4. Imposta le seguenti proprietà per il nuovo nodo:

   • tipo: property (di tipo String)
   • nome proprietà: jcr:uuid (di tipo Nome)

   Questo esempio particolare indicizza jcr:uuid proprietà, il cui lavoro consiste nell’esporre l’identificatore universalmente univoco (UUID) del nodo a cui è collegata.

5. Salva le modifiche.

L’indice delle proprietà dispone delle seguenti opzioni di configurazione:

• Il tipo proprietà specifica il tipo di indice e in questo caso deve essere impostato su proprietà

• Il propertyNames proprietà indica l'elenco delle proprietà memorizzate nell'indice. Se manca, il nome del nodo viene utilizzato come valore di riferimento del nome di proprietà. In questo esempio, la proprietà jcr:uuid La proprietà il cui lavoro consiste nell’esporre l’identificatore univoco (UUID) del relativo nodo viene aggiunta all’indice.

• Il univoco flag che, se impostato su true aggiunge un vincolo di univocità nell'indice delle proprietà.

• Il DeclaringNodeTypes proprietà consente di specificare un determinato tipo di nodo a cui si applica solo l’indice.

• Il reindicizzare flag che, se impostato su true, attiva una reindicizzazione completa del contenuto.

Indice ordinato

L'indice Ordinato è un'estensione dell'indice Proprietà. Tuttavia, è stato dichiarato obsoleto. Gli indici di questo tipo devono essere sostituiti con Indice proprietà Lucene.

Indice full-text Lucene

Un indicizzatore full-text basato su Apache Lucene è disponibile in AEM 6.

Se è configurato un indice full-text, tutte le query con una condizione full-text utilizzano l'indice full-text, indipendentemente dall'esistenza di altre condizioni indicizzate e da eventuali restrizioni di percorso.

Se non è configurato alcun indice full-text, le query con condizioni full-text non funzionano come previsto.

Poiché l’indice viene aggiornato tramite un thread in background asincrono, alcune ricerche full-text non sono disponibili per una piccola finestra di tempo fino al completamento dei processi in background.

Per configurare un indice full-text Lucene, attenersi alla procedura descritta di seguito.

1. Apri CRXDE e crea un nodo sotto oak:index.

2. Denomina il nodo LuceneIndex e imposta il tipo di nodo su oak:QueryIndexDefinition

3. Aggiungi le seguenti proprietà al nodo:

   • tipo: lucene (di tipo String)
   • asincrono: async (di tipo String)

4. Salva le modifiche.

L’indice Lucene dispone delle seguenti opzioni di configurazione:

• Il tipo che specifica il tipo di indice deve essere impostato su lucene
• Il asincrono proprietà che deve essere impostata su asincrono. In questo modo il processo di aggiornamento dell’indice viene inviato a un thread in background.
• Il includePropertyTypes che definisce il sottoinsieme dei tipi di proprietà inclusi nell'indice.
• Il excludePropertyNames proprietà che definisce un elenco di nomi di proprietà, ovvero proprietà che devono essere escluse dall'indice.
• Il reindicizzare contrassegna che quando è impostato su true, attiva una reindicizzazione completa del contenuto.

Ricerca full-text

La documentazione di questa sezione si applica, ad esempio, agli indici Apache Lucene, Elasticsearch e full-text di PostgreSQL, SQLite e MySQL. L’esempio seguente è per AEM / Oak / Lucene.

Dati da indicizzare

Il punto di partenza sono i dati che devono essere indicizzati. Prendi ad esempio i seguenti documenti:

Indice invertito

Il meccanismo di indicizzazione suddivide il testo completo in parole chiamate "token" e crea un indice denominato "indice invertito". Questo indice contiene l'elenco dei documenti in cui viene visualizzato per ogni parola.

Le parole brevi e comuni (dette anche "parole non significative") non sono indicizzate. Tutti i token vengono convertiti in minuscolo e viene applicato lo stemming.

Caratteri speciali come "-" non sono indicizzati.

L'elenco dei documenti è ordinato. Questo è utile quando si esegue una query.

Ricerca in corso

Di seguito è riportato un esempio di query. Notare che tutti i caratteri speciali (come ') sono stati sostituiti da uno spazio:

/jcr:root/content//element(\*; cq:Page)`[` jcr:contains('Rubik s Cube')`]`

Le parole vengono tokenizzate e filtrate nello stesso modo in cui vengono indicizzate (le parole a carattere singolo vengono rimosse, ad esempio). In questo caso, la ricerca è per:

+:fulltext:rubik +:fulltext:cube

L'indice consulta l'elenco dei documenti per tali parole. Se sono presenti molti documenti, l'elenco può essere di grandi dimensioni. Ad esempio, supponiamo che contengano quanto segue:

Lucene gira avanti e indietro tra i due elenchi (o round robin) n elenchi, durante la ricerca n word):

• Leggi nel "rubik" ottiene la prima voce: trova 10
• Lettura nel "cubo" ottiene la prima voce > = 10. 10 non è stato trovato, quindi quello successivo è 30.
• Leggi in "rubik" ottiene la prima voce > = 30: trova 100.
• Lettura nel "cubo" ottiene la prima voce > = 100: trova 200.
• Leggi in "rubik" ottiene la prima voce > = 200. 200. Quindi il documento 200 corrisponde a entrambi i termini. Questo viene ricordato.
• Leggi nella "rubik" ottiene la prossima voce: 1000.
• Lettura nel "cubo" ottiene la prima voce > = 1000: trova 2000.
• Leggi in "rubik" ottiene la prima voce > = 2000: fine dell’elenco.
• Infine, puoi interrompere la ricerca.

L’unico documento trovato che contiene entrambi i termini è 200, come nell’esempio seguente:

Quando vengono trovate più voci, queste vengono ordinate in base al punteggio.

Indice della proprietà Lucene

Da Oak 1.0.8, Lucene può essere utilizzato per creare indici che coinvolgono vincoli di proprietà che non sono full-text.

Per ottenere un indice della proprietà Lucene, fulltextEnabled La proprietà deve sempre essere impostata su false.

Prendi il seguente esempio di query:

select * from [nt:base] where [alias] = '/admin'

Per definire un indice delle proprietà Lucene per la query precedente, puoi aggiungere la seguente definizione creando un nodo in quercia:index:

• Nome: LucenePropertyIndex
• Tipo: oak:QueryIndexDefinition

Una volta creato il nodo, aggiungi le seguenti proprietà:

• tipo:

  lucene (of type String)
  

• asincrono:

  async (of type String)
  

• fulltextEnabled:

  false (of type Boolean)
  

• includePropertyNames: ["alias"] (of type String)

Analizzatori Lucene

Dalla versione 1.2.0, Oak supporta gli analizzatori Lucene.

Gli analizzatori vengono utilizzati sia quando un documento viene indicizzato che al momento della query. Un analizzatore esamina il testo dei campi e genera un flusso di token. Gli analizzatori Lucene sono composti da una serie di classi di tokenizzatore e filtro.

Gli analizzatori possono essere configurati mediante analyzers nodo (di tipo nt:unstructured) all'interno del oak:index definizione.

L’analizzatore predefinito per un indice è configurato in default elemento secondario del nodo analizzatori.

Specifica diretta della classe dell'analizzatore

Se desideri utilizzare un analizzatore predefinito, puoi configurarlo seguendo la procedura seguente:

1. Individua l’indice con cui desideri utilizzare l’analizzatore sotto oak:index nodo.

2. Nell’indice, crea un nodo secondario denominato default di tipo nt:unstructured.

3. Aggiungi una proprietà al nodo predefinito con le seguenti proprietà:

   • Nome: class
   • Tipo: String
   • Valore: org.apache.lucene.analysis.standard.StandardAnalyzer

   Il valore è il nome della classe dell'analizzatore che si desidera utilizzare.

   È inoltre possibile impostare l'analizzatore da utilizzare con una versione specifica di Lucene utilizzando l' luceneMatchVersion proprietà stringa. Una sintassi valida per utilizzarlo con Lucene 4.7 sarebbe:

   • Nome: luceneMatchVersion
   • Tipo: String
   • Valore: LUCENE_47

   Se luceneMatchVersion non viene fornito, Oak utilizza la versione di Lucene con cui viene fornito.

4. Se desideri aggiungere alle configurazioni dell’analizzatore un file di parole d’arresto, puoi creare un nodo sotto default uno con le seguenti proprietà:

   • Nome: stopwords
   • Tipo: nt:file

Creazione di analizzatori tramite la composizione

Gli analizzatori possono essere composti anche in base a Tokenizers, TokenFilters, e CharFilters. Per farlo, specifica un analizzatore e crea nodi secondari dei suoi tokenizer e filtri opzionali applicati nell’ordine elencato. Vedi anche https://cwiki.apache.org/confluence/display/solr/AnalyzersTokenizersTokenFilters#Specifying_an_Analyzer_in_the_schema

Considera questa struttura di nodi come un esempio:

• Nome: analyzers

  • Nome: default

    • Nome: charFilters

    • Tipo: nt:unstructured

      • Nome: HTMLStrip
      • Nome: Mapping

    • Nome: tokenizer

      • Nome proprietà: name

        • Tipo: String
        • Valore: Standard

    • Nome: filters

    • Tipo: nt:unstructured

      • Nome: LowerCase

      • Nome: Stop

        • Nome proprietà: words

          • Tipo: String
          • Valore: stop1.txt, stop2.txt

        • Nome: stop1.txt

          • Tipo: nt:file

        • Nome: stop2.txt

          • Tipo: nt:file

Il nome dei filtri, charFilters e dei token viene formato rimuovendo i suffissi di fabbrica. Pertanto:

• org.apache.lucene.analysis.standard.StandardTokenizerFactory diventa standard

• org.apache.lucene.analysis.charfilter.MappingCharFilterFactory diventa Mapping

• org.apache.lucene.analysis.core.StopFilterFactory diventa Stop

Qualsiasi parametro di configurazione richiesto per la factory viene specificato come proprietà del nodo in questione.

In casi quali il caricamento di parole non significative in cui è necessario caricare contenuto da file esterni, il contenuto può essere fornito creando un nodo figlio di nt:file digita per il file in questione.

Indice Solr

L'indice Solr è una ricerca full-text, ma può anche essere utilizzato per indicizzare la ricerca in base al percorso, alle restrizioni di proprietà e alle restrizioni di tipo primario. Ciò significa che l’indice Solr in Oak può essere utilizzato per qualsiasi tipo di query JCR.

L’integrazione nell’AEM avviene a livello di archivio, in modo che Solr sia uno dei possibili indici che possono essere utilizzati in Oak, la nuova implementazione dell’archivio fornita con AEM.

Può essere configurato per funzionare come server remoto con l’istanza AEM.

Configurazione di AEM con un unico server Solr remoto

L'AEM può anche essere configurato per funzionare con un'istanza remota del server Solr:

1. Scarica ed estrai l’ultima versione di Solr. Per ulteriori informazioni su come eseguire questa operazione, vedi Documentazione di installazione di Apache Solr.

2. Ora, crea due frammenti Solr. A tale scopo, creare cartelle per ogni frammento della cartella in cui è stato decompresso Solr:

   • Per la prima partizione, crea la cartella:

   <solrunpackdirectory>\aemsolr1\node1

   • Per la seconda partizione, crea la cartella:

   <solrunpackdirectory>\aemsolr2\node2

3. Individuare l'istanza di esempio nel pacchetto Solr. Si trova in una cartella denominata " example" nella radice del pacchetto.

4. Copiare le cartelle seguenti dall'istanza di esempio nelle due cartelle condivise ( aemsolr1\node1 e aemsolr2\node2):

   • contexts
   • etc
   • lib
   • resources
   • scripts
   • solr-webapp
   • webapps
   • start.jar

5. Crea una cartella denominata " cfg" in ognuna delle due cartelle condivise.

6. Posizionare i file di configurazione Solr e Zookeeper nella nuova cfg cartelle.

   NOTA

   Per ulteriori informazioni sulla configurazione di Solr e ZooKeeper, consulta Documentazione sulla configurazione Solr e Guida introduttiva di ZooKeeper.

7. Iniziare la prima partizione con il supporto ZooKeeper andando a aemsolr1\node1 ed eseguendo il comando seguente:

   java -Xmx2g -Dbootstrap_confdir=./cfg/oak/conf -Dcollection.configName=myconf -DzkRun -DnumShards=2 -jar start.jar
   

8. Iniziare la seconda partizione scegliendo aemsolr2\node2 ed eseguendo il comando seguente:

   java -Xmx2g -Djetty.port=7574 -DzkHost=localhost:9983 -jar start.jar
   

9. Dopo aver avviato entrambe le partizioni, verificare che tutto sia funzionante collegandosi all'interfaccia Solr all'indirizzo http://localhost:8983/solr/#/

10. Avvia AEM e passa alla console web all’indirizzo http://localhost:4502/system/console/configMgr

11. Imposta la seguente configurazione in Configurazione server remoto Oak Solr:

    • URL HTTP Solr: http://localhost:8983/solr/

12. Scegli Solr remoto nell’elenco a discesa in Oak Solr provider di server.

13. Vai a CRXDE e accedi come Amministratore.

14. Crea un nodo denominato solrIndex in oak:index e impostare le seguenti proprietà:

    • tipo: solr (di tipo String)
    • asincrono: asincrono (di tipo String)
    • reindicizza: true (di tipo Boolean)

15. Salva le modifiche.

Configurazione consigliata per Solr

Di seguito è riportato un esempio di configurazione di base che può essere utilizzata con tutte e tre le implementazioni Solr descritte in questo articolo. Consente di gestire gli indici di proprietà dedicati già presenti nell’AEM; non utilizzarli con altre applicazioni.

Per utilizzarlo correttamente, è necessario inserire il contenuto dell'archivio direttamente nella home directory Solr. In caso di distribuzioni con più nodi, questa deve trovarsi direttamente nella cartella principale di ciascun nodo.

File di configurazione Solr consigliati

Ottieni file

Strumenti di indicizzazione AEM

AEM 6.1 integra anche due strumenti di indicizzazione presenti in AEM 6.0 come parte degli strumenti Adobe Consulting Services Commons:

1. Spiega query, strumento progettato per aiutare gli amministratori a comprendere come vengono eseguite le query;
2. Gestore indice Oak, interfaccia utente Web per la gestione degli indici esistenti.

Ora puoi raggiungerli andando in Strumenti - Operazioni - Dashboard - Diagnosi dalla schermata iniziale dell’AEM.

Per ulteriori informazioni su come utilizzarli, vedi Documentazione del dashboard operazioni.

Creazione di indici di proprietà tramite OSGi

Il pacchetto ACS Commons espone anche configurazioni OSGi che possono essere utilizzate per creare indici di proprietà.

Puoi accedervi dalla console web cercando "Assicurati che l’indice della proprietà Oak sia corretto".

Risoluzione dei problemi di indicizzazione

Possono verificarsi situazioni in cui l’esecuzione delle query richiede molto tempo e il tempo di risposta generale del sistema è lento.

Questa sezione presenta una serie di raccomandazioni su ciò che deve essere fatto per rintracciare la causa di tali problemi e consigli su come risolverli.

Preparazione delle informazioni di debug per l'analisi

Il modo più semplice per ottenere le informazioni richieste per la query in esecuzione è tramite Strumento Spiega query. Questo consente di raccogliere le informazioni precise necessarie per eseguire il debug di una query lenta senza dover consultare le informazioni a livello di registro. Ciò è utile se si conosce la query di cui viene eseguito il debug.

Se questo non è possibile per qualsiasi motivo, puoi raccogliere i registri di indicizzazione in un singolo file e utilizzarli per risolvere il problema specifico.

Abilita registrazione

Per abilitare la registrazione, devi abilitare DEBUG registri a livello per le categorie relative all’indicizzazione Oak e alle query. Tali categorie sono:

• org.apache.jackrabbit.oak.plugins.index
• org.apache.jackrabbit.oak.query
• com.day.cq.search

Il com.day.cq.search è applicabile solo se si utilizza l'utilità QueryBuilder fornita dall'AEM.

Per abilitare la registrazione, segui questa procedura:

1. Puntare il browser a https://serveraddress:port/system/console/slinglog
2. Fai clic su Aggiungi nuovo logger nella parte inferiore della console.
3. Nella riga appena creata, aggiungi le categorie sopra indicate. È possibile utilizzare + accedere per aggiungere più categorie a un singolo logger.
4. Scegli DEBUG dal Livello di registro elenco a discesa.
5. Imposta il file di output su logs/queryDebug.log. In questo modo tutti gli eventi DEBUG vengono correlati in un unico file di registro.
6. Esegui la query o esegui il rendering della pagina che utilizza la query su cui desideri eseguire il debug.
7. Dopo aver eseguito la query, torna alla console di registrazione e modifica il livello di registro del logger appena creato in INFO.

Configurazione indice

Il modo in cui la query viene valutata è influenzato in gran parte dalla configurazione dell’indice. È importante che la configurazione dell’indice sia analizzata o inviata al supporto. Puoi ottenere la configurazione come pacchetto di contenuti o una rappresentazione JSON.

Di solito, la configurazione dell’indicizzazione viene memorizzata in /oak:index in CRXDE, puoi ottenere la versione JSON in:

https://serveraddress:port/oak:index.tidy.-1.json

Se l’indice è configurato in una posizione diversa, modifica di conseguenza il percorso.

Uscita MBean

A volte è utile fornire l’output di MBean correlati all’indice per il debug. Per farlo, segui questi passaggi:

1. Vai alla console JMX all’indirizzo:
   https://serveraddress:port/system/console/jmx

2. Cerca i seguenti MBean:

   • Statistiche indice Lucene
   • Statistiche di supporto CopyOnRead
   • Statistiche query Oak
   • IndexStats

3. Fare clic su ogni MBean per ottenere statistiche sulle prestazioni. Crea uno screenshot o annotali nel caso sia necessario un invio di supporto.

Puoi ottenere la variante JSON di queste statistiche anche dai seguenti URL:

• https://serveraddress:port/system/sling/monitoring/mbeans/org/apache/jackrabbit/oak/%2522LuceneIndex%2522.tidy.-1.json
• https://serveraddress:port/system/sling/monitoring/mbeans/org/apache/jackrabbit/oak/%2522LuceneIndex%2522.tidy.-1.json
• https://serveraddress:port/system/sling/monitoring/mbeans/org/apache/jackrabbit/oak/%2522LuceneIndex%2522.tidy.-1.json
• https://serveraddress:port/system/sling/monitoring/mbeans/org/apache/jackrabbit/oak/%2522LuceneIndex%2522.tidy.-1.json

Puoi anche fornire un output JMX consolidato tramite https://serveraddress:port/system/sling/monitoring/mbeans/org/apache/jackrabbit/oak.tidy.3.json. Questo includerebbe tutti i dettagli MBean relativi a Oak in formato JSON.

Altri dettagli

Puoi raccogliere ulteriori dettagli per risolvere il problema, ad esempio:

1. La versione Oak su cui è in esecuzione l’istanza. Per visualizzarlo, apri CRXDE e osserva la versione nell’angolo in basso a destra della pagina di benvenuto, oppure controlla la versione di org.apache.jackrabbit.oak-core pacchetto.
2. L’output di QueryBuilder Debugger della query problematica. Il debugger è accessibile all’indirizzo: https://serveraddress:port/libs/cq/search/content/querydebug.html