IBM Books
(C) IBM Corp. 2000

DB2 Extension Net Search - Guide d'administration et d'utilisation

DB2EXT.HIGHLIGHT

La fonction db2ext.highlight permet d'obtenir des informations sur les raisons pour lesquelles un document a été qualifié de résultat de la recherche. Plus spécifiquement, elle peut être utilisée pour :

Notez que la fonction db2ext.highlight ne peut être utilisée qu'avec la fonction de valeur table db2ext.textsearch. La fonction de valeur table recherche dans l'index, fournissant les résultats à utiliser pour la fonction HIGHLIGHT.

Pour plus d'informations sur l'utilisation de la fonction db2ext.textsearch, reportez-vous à la section DB2EXT.TEXTSEARCH.

Syntaxe de la fonction

>>-db2ext.highlight--------------------------------------------->
 
>--(--document-content--,--hit-information--,--hit-processing-information--)-><
 
 

Paramètres de fonction

Les paramètres suivants sont les paramètres d'entrée :

document content CLOB(100K)
Seuls les documents UTF8 de format TEXT ou XML sont pris en charge. Pour augmenter cette valeur, reportez-vous à la section DB2EXTHL (utilitaire).

hit information BLOB(20K)
Chaîne contenant les informations sur les occurrences. Elle est renvoyée par la fonction db2ext.textsearch, si le paramètre numberOfHits est spécifié.

hit processing information VARCHAR(1024)
Ce paramètre est une liste de paires de valeurs d'options, séparées par une virgule et chaque caractère de la chaîne étant placé entre guillemets. Il précise comment la mise en évidence doit être traitée pour le document spécifié. Si aucune des options n'est indiquée, le document original est renvoyé.

TAGS = ("STRING", "STRING")
Cette option permet à l'utilisateur de spécifier les balises à insérer avant et après une occurrence dans le document. Si cette option est omise, aucune balise n'est ajoutée ni avant, ni après une occurrence dans le document.

WINDOW_NUMBER = INTEGER
Cette option spécifie le nombre de parties (ou fenêtres) du document devant être renvoyées par la fonction de mise en évidence (HIGHLIGHT). Chaque fenêtre comporte une ou plusieurs occurrences et la première occurrence de chaque fenêtre détermine la partie du document renvoyé à l'utilisateur. Celles-ci peuvent être ou non entourées par du texte.

Si cette option est omise, la valeur 0 est prise par défaut et le document entier contenant les balises de départ et de fin (si spécifié) est renvoyé. Dans ce cas, l'option WINDOW_SIZE est ignorée.

WINDOW_SIZE = INTEGER
Cette option spécifie la taille de fenêtre recommandée (en octets). La taille réelle peut varier, selon le nombre d'occurrences, la longueur des occurrences et les tailles de la balise de départ et de la balise de fin. Si l'option est omise, la valeur par défaut est 0. Ceci signifie que seules les occurrences sans texte autour seront renvoyées.

WINDOW_SEPARATOR = "STRING"
Cette option spécifie la balise utilisée pour séparer une fenêtre de la fenêtre suivante. Si l'option est omise, "..." est la valeur utilisée par défaut.

FORMAT = "STRING"
Cette option spécifie le format du document. Les valeurs valides sont XML ou TEXT. Si cette option est omise, TEXT est la valeur prise par défaut. Assurez-vous que la valeur du format est la même que celle spécifiée lors de l'indexation.

MODEL_NAME = "STRING"
Cette option spécifie le nom du modèle lié au document XML spécifié. Notez que si le FORMAT est TEXT, cette option a pour résultat une condition d'erreur.

SECTIONS = ("section-name1", ..., "section-nameN")
Pour les documents XML, la mise en évidence peut être limitée aux sections concernées. Par exemple, elles peuvent être définies dans le fichier modèle. Pour spécifier ces sections, séparez les noms de section par des virgules. Si cette option est omise, la mise en évidence est effectuée sur la totalité du document XML. Notez que si le FORMAT est TEXT, cette option est ignorée.

Paramètres de fonction

Les paramètres suivants sont les paramètres de renvoi :

CLOB(200K)
La fonction de mise en évidence HIGHLIGHT renvoie une valeur CLOB contenant les parties du document qu'elle a modifiées.

Usage

L'exemple suivant montre comment utiliser la fonction 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 = ("section1-name", "section2-name")')
 
FROM patent p, table (db2ext.textsearch(
       '"relational database systems"',
       'DB2EXT',
       'TI_FOR_CONTENT',
       0,
       20,
       CAST(NULL as BIGINT),
       15)) t
 
WHERE p.id = t.primkey

L'utilisation de documents de plus de 100 octets entraînera l'arrêt de la requête SQL et produira une erreur SQL (SQL 1476N et erreur sql -433). Pour éviter cela, utilisez la commande db2exthl pour augmenter la taille du contenu du document. Pour plus d'informations, reportez-vous à la section DB2EXTHL (utilitaire).

Remarque

Les caractères spéciaux comme "newline" sera renvoyé tel quel.

Restrictions


[ Début de page | Page précédente | Page suivante | Table des matières | Index ]