Files d'attente d'indexation Google Cloud Search

Le SDK Connector et l'API Google Cloud Search permettent de créer des files d'attente d'indexation Cloud Search pour effectuer les tâches suivantes:

• Déterminer l'état d'indexation de chaque document (état, valeurs de hachage, etc.) ce qui permet de synchroniser l'index avec votre dépôt

• Établir la liste des éléments à indexer selon l'analyse effectuée durant le processus de balayage

• Établir l'ordre de priorité des éléments figurant dans la file d'attente en fonction de leur état d'indexation

• Déterminer d'autres informations d'état favorisant une intégration efficace, telles que les points de contrôle, les jetons de modification, etc.

Une file d'attente est un libellé attribué à un élément indexé, tel que "par défaut" pour la file d'attente par défaut ou "B" pour la file d'attente B.

État et priorité

La priorité d'un document dans une file d'attente est fonction de son code ItemStatus. Voici les codes ItemStatus possibles par ordre de priorité (de la plus forte à la plus faible):

• ERROR : l'élément a rencontré une erreur asynchrone lors du processus d'indexation et doit être réindexé.

• MODIFIED : élément déjà indexé, mais qui a été modifié dans le dépôt depuis la dernière indexation.

• NEW_ITEM : élément non indexé.

• ACCEPTED : document précédemment indexé et qui n'a pas été modifié dans le dépôt depuis la dernière indexation.

Lorsque deux éléments d'une file d'attente ont le même état, une priorité plus élevée est accordée à ceux qui se trouvent dans la file d'attente depuis le plus longtemps.

Présentation de l'utilisation des files d'attente d'indexation pour indexer un élément nouveau ou modifié

La figure 1 montre les étapes d'indexation d'un élément nouveau ou modifié à l'aide d'une file d'attente d'indexation. Ces étapes montrent les appels d'API REST. Pour connaître les appels de SDK équivalents, consultez la section Opérations de file d'attente (SDK Connector).

Figure 1. Procédure d'indexation pour ajouter ou modifier un élément

1. Le connecteur de contenu utilise items.push pour insérer des éléments (métadonnées et hachage) dans une file d'indexation afin d'établir leur état (MODIFIED, NEW_ITEM, DELETED). Plus précisément:

   • Lors de la diffusion, le connecteur inclut explicitement une diffusion type ou contentHash.
   • Si le connecteur n'inclut pas type, Cloud Search utilise automatiquement contentHash pour déterminer l'état de l'élément.
   • Si l'article est inconnu, son état est défini sur NEW_ITEM.
   • Si l'élément existe et que les valeurs de hachage correspondent, l'état reste ACCEPTED.
   • Si l'élément existe et que les hachages sont différents, l'état devient MODIFIED.

   Pour en savoir plus sur l'état des éléments, consultez l'exemple de code Parcourir les dépôts GitHub dans le tutoriel de démarrage de Cloud Search.

   En général, la transmission est associée à des processus de balayage de contenu et/ou de détection des modifications dans le connecteur.

2. Le connecteur de contenu utilise items.poll pour interroger la file d'attente afin de déterminer les éléments à indexer. Cloud Search indique au connecteur les éléments qui ont le plus besoin d'être indexés, triés d'abord par code d'état, puis par temps d'attente dans la file d'attente.

3. Le connecteur récupère ces éléments du dépôt et crée des requêtes d'API d'index.

4. Le connecteur utilise items.index pour indexer les éléments. L'élément ne passe à l'état ACCEPTED qu'une fois le traitement de l'élément terminé par Cloud Search.

Un connecteur peut également supprimer un élément s'il n'existe plus dans le dépôt, ou en pousser un autre s'il n'est pas modifié ou s'il existe une erreur dans le dépôt source. Pour en savoir plus sur la suppression d'éléments, consultez la section suivante.

Remarque :Certaines stratégies de balayage, comme le balayage complet, utilisent plusieurs files d'indexation. Pour obtenir un exemple d'utilisation de deux files d'attente, consultez la section suivante.

Présentation de l'utilisation des files d'attente d'indexation pour supprimer un élément

La stratégie de balayage complet utilise un processus à deux files d'attente pour indexer les éléments et détecter les suppressions. La figure 2 montre les étapes de suppression d'un élément à l'aide de deux files d'indexation. Plus précisément, la figure 2 illustre le deuxième balayage effectué à l'aide d'une stratégie de balayage complet. Ces étapes utilisent des appels d'API REST. Pour les appels de SDK équivalents, consultez la section Opérations de file d'attente (SDK Connector).

Figure 2. Supprimer des éléments

Remarque :Dans la liste d'étapes suivante, les étapes 1 à 4 ne sont pas illustrées dans la figure 2, car elles sont identiques aux étapes 1 à 4 du diagramme précédent et ne relèvent pas du champ d'application de cette section. L'étape 5 n'est pas affichée, car l'appel de deleteQueueItems sur une file d'attente vide n'entre pas dans le champ d'application de cette section. Ce diagramme se concentre sur la deuxième traversée.

1. Lors du premier balayage, le connecteur de contenu utilise items.push pour insérer des éléments (métadonnées et hachage) dans une file d'indexation, "file A" en tant que NEW_ITEM, car il n'existe pas dans la file. Chaque élément est associé au libellé "A" pour "file d'attente A". Le contenu est indexé dans Cloud Search.

   Remarque :Le connecteur peut attribuer un libellé de file d'attente à un élément lors d'une opération item.push ou item.index à l'aide du champ queue de l'élément. Ce libellé peut être modifié chaque fois que l'élément est réenvoyé ou réindexé.

2. Le connecteur de contenu utilise items.poll pour interroger la file d'attente A afin de déterminer les éléments à indexer. Cloud Search indique au connecteur les éléments qui ont le plus besoin d'être indexés, triés d'abord par code d'état, puis par temps d'attente dans la file d'attente.

3. Le connecteur récupère ces éléments du dépôt et crée des requêtes d'API d'index.

4. Le connecteur utilise items.index pour indexer les éléments. L'élément ne passe à l'état ACCEPTED qu'une fois le traitement de l'élément terminé par Cloud Search.

5. La méthode deleteQueueItems est appelée sur "queue B". Toutefois, aucun élément n'a été transféré vers la file d'attente B. Rien ne peut donc être supprimé.

6. Lors de la deuxième traversée complète, le connecteur de contenu utilise items.push pour insérer des éléments (métadonnées et hachage) dans la file d'attente B:

   • Lors du transfert, le connecteur inclut explicitement une commande push type ou contentHash.
   • Si le connecteur n'inclut pas type, Cloud Search utilise automatiquement contentHash pour déterminer l'état de l'élément.
   • Si l'élément est inconnu, son état est défini sur NEW_ITEM et le libellé de la file d'attente est remplacé par "B".
   • Si l'élément existe et que les valeurs de hachage correspondent, l'état reste ACCEPTED et le libellé de la file d'attente est remplacé par "B."
   • Si l'élément existe et que les hachages sont différents, l'état devient MODIFIED et le libellé de la file d'attente est remplacé par "B."

7. Le connecteur de contenu utilise items.poll pour interroger la file d'attente afin de déterminer les éléments à indexer. Cloud Search indique au connecteur les éléments qui nécessitent le plus d'indexation, en les triant d'abord par code d'état, puis par temps de file d'attente.

8. Le connecteur récupère ces éléments à partir du dépôt et crée des requêtes d'API d'index.

9. Le connecteur utilise items.index pour indexer les éléments. L'élément ne passe à l'état ACCEPTED qu'une fois le traitement de l'élément terminé par Cloud Search.

10. Enfin, deleteQueueItems est appelé dans la file d'attente A pour supprimer tous les éléments CCloud Search précédemment indexés qui possèdent toujours un libellé de file d'attente "A".

11. Lors des traversées complètes ultérieures, la file d'attente utilisée pour l'indexation et la file d'attente utilisée pour la suppression sont échangées.

Opérations de file d'attente (SDK Connector)

Le SDK Content Connector fournit des opérations permettant d'ajouter des éléments à une file d'attente ou d'en retirer.

Pour empaqueter et ajouter un élément à une file d'attente, utilisez la classe de générateur pushItems.

Aucune action de votre part n'est requise pour extraire des éléments d'une file d'attente à traiter. Au lieu de cela, le SDK extrait automatiquement des éléments de la file d'attente, par ordre de priorité, à l'aide de la méthode getDoc de la classe Repository.

Opérations de file d'attente (API REST)

L'API REST fournit les deux méthodes suivantes permettant d'ajouter et de retirer des éléments dans une file d'attente:

• Pour ajouter un élément à une file d'attente, utilisez Items.push.
• Pour interroger les éléments de la file d'attente, utilisez Items.poll.

Vous pouvez également ajouter des éléments à la file d'attente pendant l'indexation avec Items.index. Les éléments insérés dans la file d'attente lors de l'indexation ne nécessitent pas de type et sont automatiquement attribués à l'état ACCEPTED.

Items.push

La méthode Items.push ajoute des ID à la file d'attente. Elle peut être appelée avec une valeur type spécifique qui détermine le résultat de l'opération d'ajout. Pour obtenir la liste des valeurs type, consultez le champ item.type dans la méthode Items.push.

Le transfert d'un nouvel ID entraîne l'ajout d'une nouvelle entrée avec un code NEW_ITEM ItemStatus.

La charge utile facultative est toujours stockée, traitée comme une valeur opaque et renvoyée par Items.poll.

Lorsqu'un élément est interrogé, il est réservé, ce qui signifie qu'il ne peut pas être renvoyé par un autre appel à Items.poll. L'utilisation de Items.push avec type comme NOT_MODIFIED, REPOSITORY_ERROR ou REQUEUE permet d'annuler la réservation des entrées d'interrogation. Pour en savoir plus sur les entrées réservées et disponibles, consultez la section Items.poll.

Items.push avec hachages

L'API Google Cloud Search permet de spécifier les valeurs de hachage des métadonnées et du contenu dans les requêtes Items.index. Plutôt que de spécifier type, vous pouvez indiquer les valeurs de hachage des métadonnées et/ou du contenu à l'aide d'une requête d'ajout. La file d'attente d'indexation Cloud Search compare les valeurs de hachage fournies aux valeurs stockées disponibles avec l'élément de la source de données. En cas d'incohérence, cette entrée est marquée comme MODIFIED. Si aucun élément correspondant n'existe dans l'index, l'état de l'élément devient alors NEW_ITEM.

Remarque :Les valeurs de hachage fournies avec les requêtes Items.push ne sont pas enregistrées avec l'élément. Elles servent uniquement à déterminer si l'élément a été modifié.

Items.poll

La méthode Items.poll récupère les entrées ayant la priorité la plus élevée dans la file d'attente. Les valeurs d'état demandées et renvoyées indiquent l'état de la ou des files d'attente prioritaires demandées ou l'état des ID renvoyés.

Par défaut, les entrées de n'importe quelle section de la file d'attente peuvent être renvoyées, en fonction de la priorité. Chaque entrée renvoyée est réservée et n'est plus renvoyée par les autres appels à Items.poll, jusqu'à ce que l'un des événements suivants se produise:

• La réservation expire.
• L'entrée est de nouveau mise en file d'attente par Items.index.
• Items.push est appelé avec une valeur type de NOT_MODIFIED, REPOSITORY_ERROR ou REQUEUE.