DokumentationAEM as a Cloud ServiceBenutzerhandbuch

Query Builder-Prädikatsreferenz query-builder-predicate-reference

Last update: Mon Jul 15 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

Erstellt für:

  • Admin
  • Entwickler

Allgemein general

root root

Die Stammprädikatsgruppe. Sie unterstützt alle Eigenschaften einer Gruppe und ermöglicht das Festlegen globaler Abfrageparameter.

Der Name „root“ wird in Abfragen nie verwendet, er ist implizit.

Eigenschaften properties-18

  • p.offset: Zahl, die den Anfang der Ergebnisseite anzeigt, d. h. wie viele Elemente übersprungen werden sollen.

  • p.limit: Zahl, die die Seitengröße anzeigt.

  • p.guessTotal: empfohlen: Dies vermeidet die Berechnung der vollen Ergebnissumme, die sehr kostspielig sein kann. Entweder eine Zahl, die die maximal zu zählende Summe angibt (z. B. 1.000, eine Zahl, die Benutzenden genügend Feedback zur groben Größe und exakten Zahlen für kleinere Ergebnisse gibt). Oder true, um nur bis zu dem erforderlichen Minimum p.offset + p.limit zu zählen.

  • p.excerpt: Wenn auf true gesetzt, wird der vollständige Textauszug in das Ergebnis aufgenommen.

  • p.indexTag: Wenn festgelegt, enthält die Abfrage eine Index-Tag-Option (siehe Index-Tag der Abfrageoption).

  • p.facetStrategy: wenn auf oak gesetzt, delegiert Query Builder die Facettenextraktion an Oak (siehe Facetten).

  • p.hits (nur für das JSON-Servlet): Legt mit diesen Standardwerten fest, wie Treffer als JSON geschrieben werden (erweiterbar über den Dienst „ResultHitWriter“).

    • simple: Minimale Elemente wie path, title, lastmodified, excerpt (falls festgelegt).
    • full: Das Sling JSON-Rendering des Knotens, wobei jcr:path den Pfad des Treffers angibt. Standardmäßig werden nur die direkten Eigenschaften des Knotens aufgelistet und eine tiefere Baumstruktur mit p.nodedepth=N, wobei 0 die gesamte, unendliche Unterstruktur bedeutet. Fügen Sie p.acls=true hinzu, um die JCR-Berechtigungen der aktuellen Sitzung für das angegebene Ergebnis zu berücksichtigen (Zuordnungen: create = add_node, modify = set_property, delete = remove).
    • selective: Nur Eigenschaften, die in p.properties angegeben sind, wobei es sich um eine durch Leerzeichen (verwenden Sie in URLs +) getrennte Liste relativer Pfade handelt. Wenn der relative Pfad eine Tiefe von >1 hat, werden diese Eigenschaften als untergeordnete Objekte dargestellt. Die besondere Eigenschaft jcr:path umfasst den Pfad des Treffers.

group group

Dieses Prädikat ermöglicht die Erstellung verschachtelter Bedingungen. Gruppen können verschachtelte Gruppen enthalten. Alles in einer Query Builder-Abfrage gehört zu einer root-Gruppe, die auch p.or- und p.not-Parameter aufweisen kann.

Das folgende Beispiel zeigt, wie eine von zwei Eigenschaften mit einem Wert abgeglichen wird:

group.p.or=true
group.1_property=jcr:title
group.1_property.value=My Page
group.2_property=navTitle
group.2_property.value=My Page

Vom Konzept her ist es (1_property ODER 2_property).

Das folgende Beispiel zeigt verschachtelte Gruppen:

fulltext=Management
group.p.or=true
group.1_group.path=/content/wknd/ch/de
group.1_group.type=cq:Page
group.2_group.path=/content/dam/wknd
group.2_group.type=dam:Asset

Sucht nach dem Begriff Management innerhalb von Seiten in /content/wknd/ch/de oder in Assets in /content/dam/wknd.

Vom Konzept her ist es fulltext AND ( (path AND type) OR (path AND type) ). Solche ODER-Verknüpfungen benötigen aus Leistungsgründen gute Indizes.

Eigenschaften properties-6

  • p.or – Ist hierfür true festgelegt, muss nur ein Prädikat in der Gruppe übereinstimmen. Der Standardwert ist false, d. h. alle müssen übereinstimmen
  • p.not – Ist hierfür true festgelegt, wird die Gruppe nicht beachtet (standardmäßig false).
  • <predicate> – fügt verschachtelte Prädikate hinzu.
  • N_<predicate> – fügt mehrere verschachtelte Prädikate gleichzeitig hinzu, z. B. 1_property, 2_property, ....

orderby orderby

Dieses Prädikat ermöglicht die Sortierung der Ergebnisse. Wenn nach mehreren Eigenschaften sortiert werden muss, muss dieses Prädikat unter Verwendung des numerischen Präfixes mehrfach hinzugefügt werden, z. B. 1_orderby=first, 2_oderby=second.

Eigenschaften properties-13

  • orderby: Entweder der JCR-Eigenschaftsname, angezeigt durch ein vorangestelltes „@“, z. B. @jcr:lastModified bzw. @jcr:content/jcr:title, oder ein anderes Prädikat in der Abfrage, z. B. 2_property, nach dem sortiert werden soll.
  • sort: Sortierrichtung, entweder desc für absteigend oder asc für aufsteigend (Standard).
  • case: Wenn auf ignore gesetzt, wird bei der Sortierung die Groß-/Kleinschreibung nicht beachtet, d. h. a kommt vor B. Wenn leer oder nicht angegeben, wird bei der Sortierung die Groß-/Kleinschreibung beachtet, d. h. B kommt vor a

Prädikate predicates

boolproperty boolproperty

Dieses Prädikat stimmt mit den booleschen JCR-Eigenschaften überein. Akzeptiert nur die Werte true und false. Wenn der Wert false ist, besteht eine Übereinstimmung, wenn die Eigenschaft den Wert false hat, oder wenn sie überhaupt nicht existiert. Dieses Prädikat ist nützlich für die Prüfung auf boolesche Flags, die nur festgelegt werden, wenn sie aktiviert sind.

Der übernommene Parameter operation hat keine Bedeutung.

Dieses Prädikat unterstützt die Facettenextraktion und liefert Buckets für jeden true- oder false-Wert, aber nur für vorhandene Eigenschaften.

Eigenschaften properties

  • boolproperty: relativer Pfad der Eigenschaft, z. B. myFeatureEnabled oder jcr:content/myFeatureEnabled.
  • value – Wert, auf den die Eigenschaft geprüft wird, true oder false.

contentfragment contentfragment

Dieses Prädikat schränkt das Ergebnis auf Inhaltsfragmente ein.

  • Filtern wird nicht unterstützt.
  • Facettenextraktion wird nicht unterstützt.

Eigenschaften properties-1

  • contentfragment – Kann mit jedem Wert verwendet werden, um auf Inhaltsfragmente zu prüfen.

dateComparison datecomparison

Dieses Prädikat vergleicht zwei JCR-Datumseigenschaften miteinander. Kann testen, ob sie gleich, ungleich, größer oder größer-oder-gleich sind.

Ein reines Filterprädikat, das keinen Suchindex verwenden kann.

Eigenschaften properties-2

  • property1 – Pfad zur Eigenschaft mit dem ersten Datum.

  • property2 – Pfad zur Eigenschaft mit dem zweiten Datum.

  • operation

    • = für exakte Übereinstimmung (Standard)
    • != für unterschiedliche Werte
    • > für property1 größer als property2
    • >= für property1 größer als oder gleich property2

daterange daterange

Dieses Prädikat gleicht JCR-Datumseigenschaften mit einem Datums-/Zeitintervall ab. Verwendet das ISO8601-Format
für Daten und Uhrzeiten (YYYY-MM-DDTHH:mm:ss.SSSZ), wobei auch Teildarstellungen möglich sind, z. B. YYYY-MM-DD. Alternativ kann der Zeitstempel auch als POSIX-Zeit angegeben werden.

Sie können nach allen Elementen zwischen zwei Zeitstempeln suchen, nach allem, was neuer oder älter als ein jeweiliges Datum ist, und aus inklusiven oder offenen Intervallen auswählen.

Es unterstützt die Facettenextraktion und stellt die Buckets today, this week, this month, last 3 months, this year, last year und earlier than last year bereit.

Filtern wird nicht unterstützt.

Eigenschaften properties-3

  • property: Relativer Pfad zu einer DATE-Eigenschaft, z. B. jcr:lastModified.
  • lowerBound: Untere Datumsgrenze, auf welche die Eigenschaft überprüft werden soll, z. B. 2014-10-01.
  • lowerOperation – > (neuer) oder >= (gleich alt oder neuer), gilt für lowerBound. Standard: >
  • upperBound: Obere Datumsgrenze, auf welche die Eigenschaft überprüft werden soll, z. B. 2014-10-01T12:15:00.
  • upperOperation – < (älter) oder <= (gleich alt oder älter), gilt für upperBound. Standard: <
  • timeZone – Kennung der Zeitzone, die verwendet werden soll, wenn keine ISO-8601-Datumszeichenfolge angegeben wird. Der Standardwert ist die standardmäßige Zeitzone des Systems.

excludepaths excludepaths

Dieses Prädikat schließt Knoten aus dem Ergebnis aus, wenn ihr Pfad mit einem regulären Ausdruck übereinstimmt.

Ein reines Filterprädikat, das keinen Suchindex verwenden kann.

Facettenextraktion wird nicht unterstützt.

Eigenschaften properties-4

  • excludepaths – Regulärer Ausdruck, der anhand von Ergebnispfaden ausgewertet wird, wobei übereinstimmende aus dem Ergebnis ausgeschlossen werden.

fulltext fulltext

Sucht nach Ausdrücken im Volltextindex.

Filtern wird nicht unterstützt.

Facettenextraktion wird nicht unterstützt.

Eigenschaften properties-5

  • fulltext: Die Volltext-Suchbegriffe
  • relPath – Der relative Pfad, der in der Eigenschaft oder dem Teilknoten durchsucht werden soll. Diese Eigenschaft ist optional.

hasPermission haspermission

Dieses Prädikat beschränkt das Ergebnis auf Elemente, bei denen die aktuelle Sitzung die angegebenen JCR-Privilegien aufweist.

Ein reines Filterprädikat, das keinen Suchindex verwenden kann. Facettenextraktion wird nicht unterstützt.

Eigenschaften properties-7

  • hasPermission: Alle durch Kommas getrennten JCR-Berechtigungen, die die aktuelle Benutzersitzung für den betreffenden Knoten haben muss. Zum Beispiel jcr:write, jcr:modifyAccessControl

language language

Dieses Prädikat findet AEM-Seiten in einer bestimmten Sprache. Dabei werden sowohl die Spracheigenschaft der Seite als auch der Seitenpfad betrachtet, der häufig die Sprache oder das Gebietsschema in einer Site-Struktur der höchsten Ebene enthält.

Ein reines Filterprädikat, das keinen Suchindex verwenden kann.

Es unterstützt die Facettenextraktion und stellt Buckets für jeden eindeutigen Sprach-Code zur Verfügung.

Eigenschaften properties-8

  • language: ISO-Sprach-Code, z. B. de.

mainasset mainasset

Dieses Prädikat prüft, ob ein Knoten ein DAM-Haupt-Asset und kein Unter-Asset ist. Dies ist im Grunde jeder Knoten, der sich nicht in einem Unter-Asset-Knoten befindet. Es wird nicht auf den Knotentyp dam:Asset geprüft. Um dieses Prädikat zu verwenden, legen Sie mainasset=true oder mainasset=false fest. Es gibt keine weiteren Eigenschaften.

Ein reines Filterprädikat, das keinen Suchindex verwenden kann.

Es unterstützt die Facettenextraktion und bietet zwei Buckets für Haupt- und Unter-Assets.

Eigenschaften properties-9

  • mainasset – Boolescher Wert, true für Haupt-Assets, false für Unter-Assets.

memberOf memberof

Dieses Prädikat sucht Objekte, die Mitglieder einer bestimmten Sling-Ressourcensammlung sind.

Ein reines Filterprädikat, das keinen Suchindex verwenden kann.

Facettenextraktion wird nicht unterstützt.

Eigenschaften properties-10

  • memberOf – Pfad der Sling-Ressourcensammlung.

nodename nodename

Dieses Prädikat stimmt mit den JCR-Knotennamen überein.

Es unterstützt die Facettenextraktion und stellt Buckets für jeden eindeutigen Knotennamen (Dateinamen) bereit.

Eigenschaften properties-11

  • nodename – Knotennamenmuster, das Platzhalter ermöglicht: * = beliebiges oder kein Zeichen, ? = beliebiges Zeichen, [abc]= nur die Zeichen in den eckigen Klammern.

notexpired notexpired

Dieses Prädikat wertet Elemente aus, indem überprüft wird, ob eine JCR-Datumseigenschaft größer oder gleich der aktuellen Server-Zeit ist. Es kann verwendet werden, um einen expiresAt-Wert zu überprüfen und die Ergebnisse auf die Werte zu beschränken, die noch nicht abgelaufen sind (notexpired=true) bzw. die bereits abgelaufen sind (notexpired=false).

Filtern wird nicht unterstützt.

Unterstützt die Facettenextraktion auf die gleiche Weise wie das Prädikat daterange.

Eigenschaften properties-12

  • notexpired – Boolescher Wert, true für noch nicht abgelaufen (Datum in der Zukunft oder gleich), false für abgelaufen (Datum in der Vergangenheit) (erforderlich).
  • property – Relativer Pfad zur zu überprüfenden DATE-Eigenschaft (erforderlich).

path path

Dieses Prädikat sucht innerhalb eines gegebenen Pfades.

Facettenextraktion wird nicht unterstützt.

Eigenschaften properties-14

  • path: Definiert das Pfadmuster.
    • Abhängig von der Eigenschaft exact stimmt entweder der gesamte Teilbaum überein (ähnlich wie beim Anhängen von //* in xpath, wobei aber der Basispfad nicht mit eingeschlossen wird), oder nur ein exakter Pfad stimmt überein, der Platzhalter (*) enthalten kann.
      • Standardwert ist true.
        <!— * Ist die Eigenschaft selffestgelegt, wird der gesamte Teilbaum einschließlich des Basisknotens durchsucht —>
  • exact: Wenn exact true ist, muss der exakte Pfad übereinstimmen, darf aber bestimmte einfache Platzhalter (*) enthalten, die mit Namen übereinstimmen, aber nicht /. Wenn die Option false (Standard) ist, werden alle untergeordneten Elemente berücksichtigt (optional).
  • flat: Durchsucht nur die direkt untergeordneten Elemente (ähnlich wie das Anhängen von /* in xpath). Wird nur verwendet, wenn exact nicht „true“ ist (optional).
  • self: Durchsucht den Teilbaum, aber bezieht den als Pfad angegebenen Basisknoten mit ein (keine Platzhalter).
    • Wichtiger Hinweis: Es wurde ein Problem mit der self-Eigenschaft in der aktuellen Implementierung von QueryBuilder erkannt. Die Verwendung in Abfragen kann zu falschen Suchergebnissen führen. Es ist auch nicht möglich, die aktuelle Implementierung der self-Eigenschaft zu ändern, da dadurch bestehende Anwendungen, die sich darauf stützen, beschädigt werden können. Aufgrund dieser Tatsache wird die self-Eigenschaft nicht mehr unterstützt, und es wird empfohlen, sie nicht mehr zu verwenden.

property property

Dieses Prädikat sucht nach JCR-Eigenschaften und ihren Werten.

Es unterstützt die Facettenextraktion und stellt für jeden eindeutigen Eigenschaftswert in den Ergebnissen einen Bucket zur Verfügung.

Eigenschaften properties-15

  • property: Relativer Pfad der Eigenschaft, z. B. jcr:title.

  • value: Wert, auf den die Eigenschaft überprüft werden soll. Verarbeitet Umwandlungen anhand des JCR-Eigenschaftstyps als Zeichenfolgen.

  • N_value: Verwenden Sie 1_value, 2_value, …, um auf mehrere Werte zu prüfen (standardmäßig kombiniert mit OR, bzw. mit AND, wenn and=true).

  • and: Legen Sie hierfür true fest, um mehrere Werte (N_value) mit AND zu kombinieren.

  • operation

    • equals für exakte Übereinstimmung (Standard).

    • unequals für unterschiedliche Werte.

    • like, um die xpath-Funktion jcr:like zu verwenden (optional).

    • not, wenn keine Übereinstimmung (z. B. not(@prop) in xpath, der value-Parameter wird ignoriert)

    • exists zur Überprüfung des Vorhandenseins.

      • true, wenn die Eigenschaft vorhanden sein muss.
      • false ist dasselbe wie not und ist der Standard.

  • depth: Anzahl der Platzhalterebenen, unter denen die Eigenschaft bzw. der relative Pfad bestehen kann (z. B. property=size depth=2 überprüft node/size, node/*/size und node/*/*/size).

rangeproperty rangeproperty

Dieses Prädikat ordnet eine JCR-Eigenschaft einem Intervall zu. Dies gilt für Eigenschaften mit linearen Typen wie LONG, DOUBLE und DECIMAL. Details zu DATE finden Sie im Prädikat daterange, das für Eingaben im Datumsformat optimiert wurde.

Sie können eine untere Grenze, eine obere Grenze oder beide definieren. Die Operation (z. B. „kleiner als“ oder „kleiner gleich“) kann auch für die untere und obere Grenze einzeln festgelegt werden.

Facettenextraktion wird nicht unterstützt.

Eigenschaften properties-16

  • property – Relativer Pfad zur Eigenschaft
  • lowerBound – Untergrenze zur Prüfung der Eigenschaft
  • lowerOperation – > (Standard) oder >=, gilt für lowerValue.
  • upperBound – Obergrenze zur Prüfung der Eigenschaft
  • upperOperation – < (Standard) oder <=, gilt für lowerValue.
  • decimal – true, wenn die überprüfte Eigenschaft vom Typ „DECIMAL“ ist.

relativedaterange relativedaterange

Dieses Prädikat gleicht JCR DATE-Eigenschaften anhand von Zeit-Offsets, die relativ zur aktuellen Server-Zeit sind, mit einem Datums-/Zeitintervall ab. Sie können lowerBound und upperBound entweder anhand eines Millisekundenwerts oder der Bugzilla-Syntax 1s 2m 3h 4d 5w 6M 7y (eine Sekunde, zwei Minuten, drei Stunden, vier Tage, fünf Wochen, sechs Monate, sieben Jahre) angeben. Mit dem Präfix - geben Sie einen negativen Offset vor der aktuellen Zeit an. Wenn Sie nur lowerBound oder nur upperBound angeben, ist der jeweils andere standardmäßig 0, was der aktuellen Zeit entspricht.

Zum Beispiel:

  • upperBound=1h (und keine lowerBound) wählt alles in der nächsten Stunde aus.
  • lowerBound=-1d (und keine upperBound) wählt alles in den letzten 24 Stunden aus.
  • lowerBound=-6M (und keine upperBound=-3M) wählt alles in den letzten 3 bis 6 Monaten aus.
  • lowerBound=-1500 und upperBound=5500 wählt alles aus, was im Zeitraum zwischen einschließlich 1500 Millisekunden in der Vergangenheit und einschließlich 5500 Millisekunden in der Zukunft liegt.
  • lowerBound=1d und upperBound=2d wählt alles am übernächsten Tag aus.

Schaltjahre werden nicht berücksichtigt, und alle Monate haben 30 Tage.

Filtern wird nicht unterstützt.

Unterstützt die Facettenextraktion auf die gleiche Weise wie das Prädikat daterange.

Eigenschaften properties-17

  • upperBound – Obere Datumsgrenze in Millisekunden oder 1s 2m 3h 4d 5w 6M 7y (eine Sekunde, zwei Minuten, drei Stunden, vier Tage, fünf Wochen, sechs Monate, sieben Jahre) relativ zur aktuellen Server-Zeit. Verwenden Sie - für einen negativen Offset.
  • lowerBound – Untere Datumsgrenze in Millisekunden oder 1s 2m 3h 4d 5w 6M 7y (eine Sekunde, zwei Minuten, drei Stunden, vier Tage, fünf Wochen, sechs Monate, sieben Jahre) relativ zur aktuellen Server-Zeit. Verwenden Sie - für einen negativen Offset.

savedquery savedquery

Dieses Prädikat fügt alle Eigenschaften einer beständigen Query Builder-Abfrage der aktuellen Abfrage als Untergruppen-Prädikat hinzu.

Es wird keine zusätzliche Abfrage ausgeführt, sondern die aktuelle Abfrage erweitert.

Abfragen können programmgesteuert anhand von QueryBuilder#storeQuery() beibehalten werden. Das Format kann entweder eine String-Eigenschaft mit mehreren Zeilen oder ein nt:file-Knoten sein, der die Abfrage als Textdatei im Java™-Eigenschaftsformat enthält.

Die Facettenextraktion wird für die Prädikate der gespeicherten Abfrage nicht unterstützt.

Eigenschaften properties-19

  • savedquery – Pfad zur gespeicherten Abfrage (String-Eigenschaft oder nt:file-Knoten).

similar similar

Dieses Prädikat ist eine Ähnlichkeitssuche unter Verwendung von rep:similar() von JCR XPath.

Filterung und Facettenextraktion werden nicht unterstützt.

Eigenschaften properties-20

  • similar – Absoluter Pfad zum Knoten, für den ähnliche Knoten gefunden werden sollen.
  • local – Ein relativer Pfad zu einem untergeordneten Knoten oder . für den aktuellen Knoten (optional, der Standard lautet .).

tag tag

Dieses Prädikat sucht nach Inhalten mit Tags, indem Tag-Titelpfade angegeben werden.

Es unterstützt die Facettenextraktion und stellt Buckets für jedes einzigartige Tag bereit. Dazu wird jeweils der aktuelle Tag-Titelpfad verwendet.

Eigenschaften properties-21

  • tag: Tag-Titelpfad, nach dem gesucht werden soll, z. B. properties:orientation/landscape.
  • N_value – Verwenden Sie 1_value, 2_value, um auf mehrere Tags zu prüfen (standardmäßig kombiniert mit OR, mit AND, wenn and=true).
  • property – Eigenschaft (bzw. relativer Pfad zur Eigenschaft), die betrachtet werden soll (Standard: cq:tags).

tagid tagid

Dieses Prädikat sucht nach Inhalten mit Tags, indem Tag-IDs angegeben werden.

Es unterstützt die Facettenextraktion und stellt Buckets für jedes einzigartige Tag bereit. Dazu wird jeweils die aktuelle Tag-ID verwendet.

Eigenschaften properties-22

  • tagid: Tag-ID, nach der gesucht werden soll, z. B. properties:orientation/landscape.
  • N_value – Verwenden Sie 1_value, 2_value, um auf mehrere Tag-IDs zu prüfen (standardmäßig kombiniert mit OR, mit AND, wenn and=true).
  • property – Eigenschaft (bzw. relativer Pfad zur Eigenschaft), die betrachtet werden soll (Standard: cq:tags).

tagsearch tagsearch

Dieses Prädikat sucht nach Inhalten mit Tags, indem Keywords angegeben werden. Es wird zunächst nach Tags gesucht, die diese Suchbegriffe in ihrem Titel enthalten, worauf das Ergebnis auf Elemente mit diesen Tags eingeschränkt wird.

Facettenextraktion wird nicht unterstützt.

Eigenschaften Properties-1

  • tagsearch – Keyword, nach dem in Tag-Titeln gesucht werden soll
  • property – Eigenschaft (bzw. relativer Pfad zur Eigenschaft), die berücksichtigt werden soll (Standard: cq:tags).
  • lang: Zum Suchen in einem bestimmten lokalisierten Tag-Titel (z. B. de).
  • all: Boolescher Wert, um im gesamten Tag-Volltext zu suchen, d. h. alle Titel, Beschreibungen usw. (hat Vorrang vor lang)

Typ type

Dieses Prädikat schränkt Ergebnisse auf einen bestimmten JCR-Knotentyp ein, sowohl auf primäre Knotentypen als auch auf mixin-Typen. Es findet auch Untertypen dieses Knotentyps. Die Indizes der Repository-Suche müssen die Knotentypen abdecken, um eine effiziente Ausführung zu gewährleisten.

Es unterstützt die Facettenextraktion und stellt für jeden eindeutigen Typ in den Ergebnissen einen Bucket zur Verfügung.

Eigenschaften Properties-2

  • type: Knotentyp oder mixin-Name, nach dem gesucht werden soll, zum Beispiel cq:Page
recommendation-more-help
fbcff2a9-b6fe-4574-b04a-21e75df764ab