Indexation ou suppression de documents

Exemple 1. Indexation d'un document

Le code suivant présente une page XSP activant la commande d'indexation de document. Les documents source, des documents XML, seront indexés dans la base sdxworld, dans un entrepôt url. Noter le test préalable sur l'appartenance de l'utilisateur courant au groupe "admins" que nous définissions comme le groupe des administrateurs de l'application courante.

<sdx:page>
	<sdx:userIsMember group="admin" >
      <sdx:uploadDocument base="sdxworld" repo="url" urlParam="url" type="text/XML" />
	</sdx:userIsMember>
</sdx:page>
			

Exemple 2. Indexation d'un lot de documents XML

Le code suivant présente l'emploi de sdx:uploadDocuments dans une page XSP. On attend certaines informations pour déclencher l'indexation : la base de documents dans laquelle on souhaite effectuer l'indexation ; le répertoire contenant les documents à indexer. On imagine que ce dernier contient non seulement les articles au format XML, mais également les images qui les illustrent. Les attributs includes et excludes sont utilisés ici dans un but pédagogique. Le premier spécifie que seul des documents XML devront être indexés ; le second spécifie que les images au format JPEG ne devront pas être prises en compte. On imagine bien que le premier est amplement suffisant dans ce cas précis !

<sdx:page>
	<sdx:uploadDocuments baseParam="base" dirParam="dir" includes="*.xml" excludes="*.jpg" />
</sdx:page>
			

Il manque bien entendu des informations à SDX pour réaliser pleinement cette indexation, par exemple le nom de l'entrepôt, le pipeline d'indexation. Ces paramètres, absents ici, doivent être définis dans le fichier application.xconf.

Exemple 3. Retirer un document de la collection

L'exemple suivant présente une page XSP activant la commande de suppression de documents. Aucune information n'est fourni (noms de l'application et de la base de document) hormis le nom du paramètre HTTP apportant l'identifiant du document que l'on souhaite retirer de la collection de documents. La page réagira ainsi à une URL du type : {serveur SDX}/sdxtest/del.xsp?id=ar5664a. Ceci supprimera toute l'information reliée au document ar5664a de la base de documents courante, de l'application courante. Ce document ne sera plus « cherchable » par SDX.

<sdx:page>
	<sdx:deleteDocument idParam="id" >
		<sdx:fallback>
			<message type="echec_suppression"/>
		</sdx:fallback>
	</sdx:deleteDocument>
</sdx:page>
			

Noter l'emploi de sdx:fallback devant afficher un message au cas où la suppression n'aurai pas réussi.

Example 4. Suppression d'un lot de document dans deux bases

L'exemple suivant présente une page XSP chargée de supprimer l'ensemble des documents de deux bases de documents. Ce n'est certainement pas la seule manière d'arriver à ce résultat ; cette page à toutefois l'avantage de fonctionner sans attendre aucune information extérieure (e.g., le qid d'une requête effectuer à partir d'une autre page XSP). Pour isoler le lot de documents, on emploie l'action de requête sdx:fieldQuery.

<sdx:page>
	<sdx:deleteDocuments delete="true" hpp="-1">
		<sdx:locations>
			<sdx:location base="docs" />
      <sdx:location base="da" />
		</sdx:locations>
		<sdx:fieldQuery field="sdxall" value="-1"/>
	</sdx:deleteDocuments>
</sdx:page>
			

Noter que sdx:deleteDocuments n'admet que les actions de construction de requêtes et non pas les actions d'exécution de requêtes (cf. Exécution des requêtes). Et bien que sdx:fieldQuery admet des informations de localisation (i.e., on peut employer directement un base="..." dans un sdx:fieldQuery), il devient indispensable d'employer sdx:locations et sdx:location pour localiser les deux bases de documents.

Exemple 5. Impossible d'indexer une nouvelle version de document

Dans l'exemple suivant, on souhaite modifier le comportement par défaut de SDX face à l'indexation de document possédant le même identifiant. On ne veut pas permettre le remplacement de document ; il est seulement possible d'en ajouter ou d'en retirer.

<sdx:page>
	<sdx:uploadDocuments appParam="a" baseParam="b" repoParam="r" dirParam="d" zipParam="z" includes="*.xml" excludes="*.jpg" sameId="ignore">
		<sdx:parameter name="attachedDocumentSameId" value="ignore" />
	</sdx:uploadDocuments>
</sdx:page>
			

On notera les deux syntaxes proposées ici pour passer les paramètres sameId et attachedDocumentSameId, à l'aide d'un attribut de sdx:uploadDocuments ou à l'aide de sdx:parameter.