Regex-Abfragen und Mustersuche

Manchmal müssen Sie nach Dokumenten suchen, bei denen ein Zeichenfolgenfeld ein bestimmtes Muster enthält, mit ihm beginnt oder mit ihm endet – den exakten Wert kennen Sie jedoch nicht. Einfache Gleichheitsfilter wie { name: 'Alice' } finden nur exakt übereinstimmende Zeichenfolgen. Reguläre Ausdrücke (Regex) ermöglichen flexible Mustervergleiche für Zeichenfolgenfelder in MongoDB.

MongoDB unterstützt Regex über den Operator $regex oder indem Sie ein JavaScript-Regex-Literal direkt in einem Abfragefilter übergeben. Beide Ansätze funktionieren, unterscheiden sich jedoch leicht in der Syntax zum Festlegen von Optionen wie der Groß- und Kleinschreibung.

Es gibt zwei Möglichkeiten, Regex in MongoDB-Abfragen zu verwenden:

• JS-Regex-Literal: { name: /alice/i } – kompakt, die Flags stehen nach dem schließenden Schrägstrich
• $regex-Operator: { name: { $regex: 'alice', $options: 'i' } } – ausführlicher, aber erforderlich, wenn Sie ihn mit anderen Operatoren kombinieren

Beide Formen liefern identische Ergebnisse. Verwenden Sie die Literal-Syntax für einfache Abfragen und die Form mit dem $regex-Operator, wenn Sie das Muster dynamisch aus einer String-Variable erstellen oder mit anderen Operatoren für dasselbe Feld kombinieren müssen.

MongoDB unterstützt vier Regex-Flags:

• i – Groß- und Kleinschreibung wird ignoriert: /alice/i findet „Alice“, „ALICE“ und „alice“
• m – Mehrzeilig: ^ und $ beziehen sich auf den Anfang bzw. das Ende jeder Zeile statt auf die gesamte Zeichenfolge
• s – Dot-all: . findet jedes Zeichen einschließlich Zeilenumbrüchen
• x – Erweitert: Leerzeichen im Muster werden ignoriert (für besser lesbare Muster mit Kommentaren)

Das am häufigsten verwendete Flag ist i. Das Flag m eignet sich für die Suche in mehrzeiligen Textfeldern wie Bloginhalten. Mehrere Flags können kombiniert werden: { $options: 'im' }.

Verwenden Sie Regex-Anker, um den Anfang oder das Ende eines Zeichenfolgenfelds zu finden:

• ^ verankert das Muster am Anfang: /^Admin/ findet Zeichenfolgen, die mit „Admin“ beginnen
• $ verankert das Muster am Ende: /\.pdf$/ findet Zeichenfolgen, die mit „.pdf“ enden

Ein wichtiger Aspekt der Performance: Ein Präfix-Regex mit Caret (/^prefix/) KANN einen regulären B-Tree-Index für dieses Feld verwenden – MongoDB kann im Index direkt zum Präfix springen. Dadurch sind Präfixsuchen deutlich schneller als Suchen innerhalb einer Zeichenfolge. Verwenden Sie bei einer großen Collection niemals einen führenden Wildcard-Ausdruck (/.*pattern/ oder /pattern/ ohne ^), wenn kein Textindex vorhanden ist.

Regex stellt ausdrucksstarke Grundelemente für Muster bereit:

• . – beliebiges Zeichen (außer Zeilenumbruch, sofern nicht das s-Flag gesetzt ist)
• [abc] – Zeichenklasse: findet a, b oder c
• [a-z] – Bereich: beliebiger Kleinbuchstabe
• \d – beliebige Ziffer (entspricht [0-9])
• \w – beliebiges Wortzeichen ([a-zA-Z0-9_])
• *, +, ? – null oder mehr, mindestens eines oder null bzw. eines
• {n}, {n,m} – genau n bzw. zwischen n und m Vorkommen

Regex-Abfragen und der MongoDB-Operator $text dienen unterschiedlichen Zwecken und weisen sehr unterschiedliche Performance-Eigenschaften auf:

• Regex: vergleicht nach Zeichenmustern. Funktioniert mit jedem Zeichenfolgenfeld und benötigt keinen speziellen Index (Präfix-Anker können jedoch B-Tree-Indizes verwenden). Geeignet für Formatvalidierung, Präfixsuchen oder Mustervergleiche in kleinen Collections bzw. indizierten Präfixabfragen.
• $text / Textindex: Volltextsuche nach Schlüsselwörtern mit Tokenisierung, Stemming und Filterung von Stoppwörtern. Erfordert einen Textindex. Bei der Suche nach Schlüsselwörtern in großen Textfeldern (Artikeln, Beschreibungen, Kommentaren) deutlich schneller.

Verwenden Sie niemals /.*keyword.*/i für eine große, nicht indizierte Collection – dies führt zu einem vollständigen Scan und kann langsam sein.

ReDoS (Regular Expression Denial of Service) ist ein Angriff, bei dem ein böswilliger Benutzer eine Eingabezeichenfolge erstellt, die dazu führt, dass ein fehlerhaft formulierter Regex für die Auswertung exponentiell lange benötigt. Wenn Sie Benutzereingaben ohne Escaping direkt in einem Regex verwenden, kann ein Angreifer Ihre Datenbankabfrage blockieren.

Escapen Sie Benutzereingaben immer, bevor Sie sie in einem Regex verwenden, indem Sie alle speziellen Regex-Zeichen (. * + ? ^ $ { } ( ) [ ] | \ ) durch ihre maskierten Entsprechungen ersetzen. Viele Bibliotheken, etwa escape-string-regexp in Node.js, erledigen dies automatisch. Verwenden Sie für Suchfelder, die Benutzern zur Verfügung stehen, außerdem vorzugsweise $text statt eines direkten Regex.

Wenn Sie einen Regex auf ein Array-Feld anwenden, prüft MongoDB, ob irgendein Element des Arrays dem Muster entspricht – mit derselben Enthaltungssemantik wie bei Gleichheitsabfragen für Arrays. So können Sie Arrays mit Tags, Kategorien oder beliebigen Zeichenfolgen durchsuchen, ohne einen speziellen Operator zu benötigen.

Beispielsweise würde ein Dokument mit tags: ['node.js', 'mongodb', 'backend'] von { tags: /^mongo/ } zurückgegeben, weil „mongodb“ mit „mongo“ beginnt. Der Regex wird unabhängig auf jedes Element angewendet.

Eine typische E-Commerce-Suche kombiniert Regex mit anderen Filtern, um eine kontextbezogene, die Groß- und Kleinschreibung ignorierende Produktsuche bereitzustellen. Die Abfrage findet Produktnamen, die den Suchbegriff an beliebiger Stelle enthalten, und filtert zusätzlich nach Kategorie und Lagerbestand.

Für kleine Kataloge (unter 50.000 Produkte) ist die Regex-Suche akzeptabel. Für größere Kataloge oder die Suche in vollständigen Beschreibungen bietet Atlas Search (auf Lucene-Basis) eine bessere Relevanzbewertung, Stemming und Performance.

Wichtige Regeln für die Regex-Performance in MongoDB:

• Präfix mit ^ (/^prefix/): Kann einen B-Tree-Index verwenden. Beste Performance bei Regex.
• Präfix mit Beachtung der Groß- und Kleinschreibung (/^prefix/): Nutzt die Indexsortierung vollständig.
• Präfix ohne Beachtung der Groß- und Kleinschreibung (/^prefix/i): Verwendet den Index teilweise, ist aber dennoch deutlich schneller als eine Abfrage ohne Anker.
• Enthaltensein ohne Anker (/pattern/): Vollständiger Collection-Scan – verwenden Sie stattdessen einen Textindex.
• Suffix (/pattern$/): Vollständiger Collection-Scan oder Textindex.

Testen Sie im Zweifelsfall mit explain('executionStats') und achten Sie auf IXSCAN im Vergleich zu COLLSCAN.

Bevor Sie eine Regex-Abfrage für eine Produktions-Collection ausführen, testen Sie das Muster mit Beispieldokumenten. So stellen Sie sicher, dass es wie beabsichtigt passende und nicht passende Dokumente findet. Mit einer kleinen limit()-Zahl können Sie dies in der MongoDB-Shell schnell prüfen. Mit JavaScripts String.prototype.test() oder Regex-Literalen können Sie Muster in Node.js validieren, bevor Sie sie in Abfragen einbetten.

Prüfen Sie außerdem die Performance mit explain(): Ein Regex, der einen vollständigen Collection-Scan erfordert, sollte in eine Textabfrage umgewandelt werden, oder Sie sollten die Größe der Collection berücksichtigen. Planen Sie bei neuen Collections die Suchanforderungen von Anfang an ein – fügen Sie Textindizes direkt hinzu, statt sie nachträglich einzurichten.

In dieser Lektion haben Sie Folgendes gelernt: Regex-Abfragen verwenden /pattern/flags oder den $regex-Operator für flexible Mustervergleiche von Zeichenfolgen – das wichtigste Flag ist i für die Unterscheidung von Groß- und Kleinschreibung. Regexe mit Präfixanker (/^prefix/) können B-Tree-Indizes für effiziente Suchen verwenden, während Muster innerhalb einer Zeichenfolge vollständige Scans erfordern. Escapen Sie Benutzereingaben immer, bevor Sie sie in einen Regex einsetzen, um ReDoS-Angriffe zu verhindern – oder verwenden Sie für die Suche durch Benutzer besser den Operator $text mit einem Textindex. Als Nächstes geht es um das Aktualisieren von Dokumenten mit $set, $unset und anderen Update-Operatoren.