DB2EXT.HIGHLIGHT

Mit der Funktion db2ext.highlight können Sie Informationen dazu ermitteln, warum ein Dokument als Suchergebnis ausgewählt wurde. Im Einzelnen können Sie mit dieser Funktion:

Beachten Sie, dass die Funktion db2ext.highlight nur zusammen mit der Tabellenwertfunktion db2ext.textsearch verwendet werden kann. Die Tabellenwertfunktion durchsucht den Index und liefert die Ergebnisse, auf die die Funktion HIGHLIGHT angewandt werden soll.

Informationen zur Verwendung der Funktion db2ext.highlight finden Sie unter DB2EXT.TEXTSEARCH.

Funktionssyntax

Syntaxdiagramm lesenSyntaxdiagramm berspringen>>-db2ext.highlight--------------------------------------------->

>--(--dokumentinhalt--,--trefferinformationen--,--informationen_zur_trefferverarbeitung--)-><

Funktionsparameter

Es gibt folgende Eingabeparameter:

dokumentinhalt CLOB(100K)
Nur UTF8-Dokumente im TEXT- oder XML-Format werden unterstützt. Informationen zur Erhöhung dieses Wertes finden Sie in DB2EXTHL (Dienstprogramm).
trefferinformationen BLOB(20K)
Eine Zeichenfolge mit Trefferinformationen. Diese Zeichenfolge wird von der Funktion db2ext.textsearch zurückgegeben, wenn ein Wert für den Parameter numberOfHits angegeben wird.
informationen_zur_trefferverarbeitung VARCHAR(1024)
Dieser Parameter ist eine Liste von Paaren der Form Option=Wert, die durch ein Komma (,) getrennt sind und wobei jedes Zeichen der Zeichenfolge in " " eingeschlossen ist. Der Parameter bestimmt die Verarbeitung der Hervorhebungen im angegebenen Dokument. Wenn keine der Optionen angegeben wird, wird das ursprüngliche Dokument zurückgegeben.
TAGS = ("STRING", "STRING")
Mit dieser Option kann der Benutzer die Tags angeben, die vor und nach einem Treffer in das Dokument einzufügen sind. Wenn Sie diese Option auslassen, werden vor und nach einem Treffer im Dokument keine Tags eingefügt.
WINDOW_NUMBER = INTEGER
Diese Option legt fest, wie viele Teile (oder Fenster) des Dokuments von der Hervorhebungsfunktion zurückgegeben werden sollen. Jedes Fenster enthält einen oder mehrere Treffer. Der erste Treffer in jedem Fenster legt den Teil des Dokuments fest, der an den Benutzer zurückgegeben wird. Diese Treffer können von Text umgeben sein oder nicht.

Wenn diese Option ausgelassen wird, wird 0 als Standardwert verwendet und das gesamte Dokument wird mit Start- und Endtags (falls definiert) zurückgegeben. In diesem Fall wird die Option WINDOW_SIZE ignoriert.

WINDOW_SIZE = INTEGER
Diese Option gibt die empfohlene Fenstergröße in Byte an. Die tatsächliche Größe kann abhängig von der Anzahl der Treffer, der Länge der Treffer und der Größe der Start- und Endtags variieren. Wenn diese Option ausgelassen wird, ist 0 der Standardwert und nur Treffer ohne umgebenden Text werden zurückgegeben.
WINDOW_SEPARATOR = "STRING"
Diese Option gibt den Tag an, der zur Trennung eines Fensters vom nächsten Fenster verwendet wird. Wenn die Option nicht angegeben wird, verwendet das System den Standardwert "...".
FORMAT = "STRING"
Diese Option gibt das Format des Dokuments an. Gültige Werte sind XML oder TEXT. Wenn diese Option ausgelassen wird, wird TEXT als Standardwert verwendet. Stellen Sie sicher, dass der Formatwert mit dem bei der Indexierung angegebenen Wert übereinstimmt.
MODEL_NAME = "STRING"
Mit dieser Option wird der Modellname angegeben, der dem angegebenen XML-Dokument zugeordnet ist. Beachten Sie hierbei, dass diese Option zu einer Fehlerbedingung führt, wenn als Format (FORMAT) die Einstellung TEXT verwendet wird.
SECTIONS = ("abschnittsname1", ..., "abschnittsnameN")
Bei XML-Dokumenten kann die Hervorhebung auf die relevanten Abschnitte beschränkt werden. Sie können z. B. in der Modelldatei definiert werden. Bei Angabe der Abschnitte werden die Namen durch Kommas getrennt. Wenn diese Option ausgelassen wird, wird die Hervorhebungsfunktion auf das gesamte XML-Dokument angewendet. Beachten Sie, dass diese Option ignoriert wird, wenn die Option FORMAT gleich TEXT ist.

Funktionsparameter

Es gibt folgende Rückgabeparameter.

CLOB(200K)
Die Funktion HIGHLIGHT gibt einen CLOB-Wert zurück, der die von der Funktion HIGHLIGHT geänderten Dokumentteile enthält.

Verwendung

Das folgende Beispiel zeigt die Verwendung der Funktion HIGHLIGHT:

select p.id,
       p.title,
       db2ext.highlight(p.content,
       t.hitinformation, 
       'TAGS = ("<bf>", "</bf>"),
       WINDOW_NUMBER = 5,
       WINDOW_SIZE = 200,
       WINDOW_SEPARATOR = "...",
       FORMAT = "XML", 
       SECTIONS = ("abschnittsname1", "abschnittsname2")')

FROM patent p, table (db2ext.textsearch(
       '"relationale Datenbanksysteme"',
         'DB2EXT',
       'TI_FOR_CONTENT',
       0,
         20,
       CAST(NULL as BIGINT),
       15)) t

WHERE p.id = t.primkey

Die Verwendung von Dokumenten mit mehr als 100 KB führt zum Abbruch der SQL-Abfrage und zur Ausgabe eines SQL-Fehlers (SQL 1476N und SQL-Fehler -433). Zur Vermeidung dieses Problems können Sie mit dem Befehl db2exthl die Dokumentinhaltsgröße erhöhen. Weitere Informationen hierzu finden Sie im Abschnitt DB2EXTHL (Dienstprogramm).

Anmerkung

Sonderzeichen wie z. B. das Zeilenschaltungszeichen werden unverändert zurückgegeben.

Restriktionen