Propriétés du tMongoDBGridFSGet Standard

Property type

Peut être Built-In ou Repository.

Built-In : aucune propriété n'est stockée de manière centrale.

Repository : Sélectionnez le fichier dans lequel sont stockées les propriétés du composant.

Use existing connection

Cochez cette case et sélectionnez le composant de connexion adéquat dans la liste Component list pour réutiliser les paramètres d'une connexion que vous avez déjà définie.

Notez que lorsqu'un Job contient un Job parent et un Job enfant, la liste Component List présente uniquement les composants de connexion du Job du même niveau.

DB Version

Liste des versions de la base de données.

Cette option est disponible lorsque la case Use existing connection n'est pas cochée.

Sélectionnez cette option pour établir une connexion utilisant une URI MongoDB Atlas. Saisissez l'URI dans le champ à droite. Consultez Connection String URI Format (en anglais) pour plus d'informations.

Cette option est disponible lorsque vous sélectionnez MongoDB 4.4.X and later dans la liste déroulante DB Version.

Use replica set address or multiple query routers

Cochez cette case pour afficher la table Server addresses.

Dans la table Server addresses, définissez les bases de données MongoDB partagées ou les ensembles de répliques MongoDB auxquel(le)s vous souhaitez vous connecter.

Server et Port

Adresse IP et port d'écoute du serveur de la base de données.

Disponible lorsque la case Use replica set address est décochée.

Notez que si vous utilisez les mécanismes d'authentification pour vous connecter à la base de données MongoDB, vous devez saisir le nom de l'hôte du serveur de la base de données plutôt que son adresse IP.

Database

Nom de la base de données.

Use SSL connection (Configure the SSL authentication in tSetKeystore or in Studio preferences)

Cochez cette case pour activer la connexion chiffrée SSL ou TLS.

Utilisez le composant tSetKeystore dans le même Job afin de spécifier les informations de chiffrement.

Notez que la connexion SSL est disponible uniquement à partir de la version 2.4 de MongoDB.

Set read preference

Cochez cette case et, dans la liste Read preference qui s'affiche, sélectionnez le membre auquel vous souhaitez adresser les opérations de lecture.

Si vous laissez décochée cette case, le Job utilise les préférences de lecture par défaut. Autrement dit, il utilise le membre primaire d'un Replica set.

Pour plus d'informations, consultez la documentation de MongoDB relative à la réplication et à ses préférences de lecture (Read preferences).

Authentification requise

Cochez cette case pour activer l'authentification à la base de données.

Parmi les mécanismes listés dans la liste déroulante Authentication mechanism, le mécanisme NEGOTIATE est recommandé si vous n'utilisez pas Kerberos, car il sélectionne automatiquement le mécanisme d'authentification le plus adapté à la version de MongoDB que vous utilisez.

Comme le mécanisme d'authentification SCRAM-SHA-256 est supporté uniquement par MongoDB 4.x et supérieures, l'option SCRAM-SHA-256 SASL est disponible uniquement lorsque MongoDB 4.4.X and later est sélectionné dans la liste déroulante DB Version.

Pour plus d'informations concernant les autres mécanismes de la liste, consultez MongoDB Authentication (en anglais) dans la documentation MongoDB.

Set Authentication database

Si le nom d'utilisateur ou d'utilisatrice à utiliser pour se connecter à MongoDB a été créé dans une base de données d'authentification MongoDB spécifique, cochez cette case pour saisir le nom de la base de données en question dans le champ Authentication database qui s'affiche.

Pour plus d'informations concernant la base de données d'authentification MongoDB, consultez User Authentication database (en anglais).

Username et Password

Données d'authentification de l’utilisateur ou l'utilisatrice de la base de données.

Pour saisir le mot de passe, cliquez sur le bouton [...] à côté du champ Password, puis, dans la boîte de dialogue qui s'ouvre, saisissez le mot de passe entre guillemets doubles et cliquez sur OK afin de sauvegarder les paramètres.

Ces champs sont disponibles lorsque la case Required authentication est cochée.

Si le système de sécurité sélectionné dans la liste Authentication mechanism est Kerberos, saisissez les informations dans les champs suivants User principal, Realm et KDC server et non dans les champs Username et Password.

Bucket

Saisissez le nom du bucket à partir duquel lire les fichiers. Un bucket de GridFS est similaire à un dossier.

Query type

Sélectionnez le type de requête que le tMongoDBGridFSGet doit exécuter pour sélectionner les données à copier.

• Filename : vous devez saisir le nom du fichier à copier. Ce nom est la valeur de l’attribut filename utilisé par ce fichier. Notez qu'un seul nom est autorisé.

  Dans GridFS, un fichier se distingue seulement par son identifiant unique (son ID d'objet) ; son nom de fichier n'est pas forcément unique.

• Mongo Query : saisissez la requête à utiliser pour sélectionner les fichiers à copier.

  La requête par défaut, {} entre guillemets doubles, fournies avec ce composant, permet de sélectionner tous les fichiers. Vous pouvez également appliquer une expression régulière en saisissant {'filename':{'$regex':'REGEX_PATTERN'}} pour définir les noms des fichiers à utiliser.

Il est recommandé d'utiliser votre requête en cochant les cases Overwrite local files et Use Document ID as output filename pour éviter tout problème de conflit dû aux noms de fichiers.

Local Folder

Saisissez le chemin du dossier dans lequel écrire les données copiées depuis GridFS.

Overwrite local files

Cochez cette case pour écraser le fichier en utilisant le même nom de fichier dans le dossier local utilisé. Dans le cas contraire, une exception sera retournée si ce type de situation est rencontré.

Use Document ID as output filename

Cochez cette case pour renommer les fichiers entrants à la volée en utilisant les valeurs de leurs ID d'objet. Cela vous permet de garder des fichiers nommés de manière identique.

tStatCatcher Statistics

Cochez cette case afin de collecter les données de log au niveau des composants.

No query timeout

Cochez cette case pour empêcher les serveurs MongoDB de fermer les curseurs inactifs après 10 minutes d'inactivité de ces curseurs. Dans cette situation, un curseur inactif reste ouvert jusqu'à ce que les résultats de ce curseur soient épuisés ou que vous fermiez manuellement le curseur à l'aide de la méthode cursor.close().

Un curseur, dans MongoDB, est un pointeur vers l'ensemble de résultats de la requête. Par défaut, c'est-à-dire lorsque la case est décochée, un serveur MongoDB ferme automatiquement les curseurs inactifs après une période d'inactivité donnée, pour éviter les utilisations excessives de mémoire. Pour plus d'informations concernant les curseurs MongoDB, consultez https://docs.mongodb.org/manual/core/cursors/ (en anglais).

Variables globales

NB_FILE : Indique le nombre de fichiers traités. Cette variable est une variable After et retourne un entier.

ERROR_MESSAGE : message d'erreur généré par le composant lorsqu'une erreur survient. Cette variable est une variable After et retourne une chaîne de caractères. Cette variable fonctionne uniquement si la case Die on error est décochée, lorsque le composant contient cette case.

Une variable Flow fonctionne durant l'exécution d'un composant. Une variable After fonctionne après l'exécution d'un composant.

Pour renseigner un champ ou une expression à l'aide d'une variable, appuyez sur les touches Ctrl+Espace pour accéder à la liste des variables. À partir de cette liste, vous pouvez choisir la variable que vous souhaitez utiliser.

Pour plus d'informations concernant les variables, consultez Utiliser les contextes et les variables.

Règle d'utilisation

Ce composant combine la connexion GridFS de MongoDB et l'extraction de données. Il est ainsi souvent utilisé comme sous-Job à un composant pour copier des données depuis GridFS dans une répertoire local défini par l'utilisateur ou l'utilisatrice.

Il est souvent relié au Job à l'aide d'un lien OnSubjobOk ou OnComponentOk, en fonction du contexte.