SHOW EXTERNAL AGENTS

Répertorie les agents externes pour lesquels vous disposez de privilèges d’accès. Les agents externes représentent les applications AI génératives dans Snowflake à utiliser avec l’observabilité AI.

La sortie renvoie les métadonnées et les propriétés de l’objet, classées lexicographiquement par nom de base de données, de schéma et d’agent externe (voir Sortie dans ce chapitre pour lire la description des colonnes de sortie).

Voir aussi :

CREATE EXTERNAL AGENT, ALTER EXTERNAL AGENT, DROP EXTERNAL AGENT, DESCRIBE EXTERNAL AGENT

Syntaxe

SHOW EXTERNAL AGENTS [ LIKE '<pattern>' ]
                     [ IN { ACCOUNT | DATABASE [ <db_name> ] | SCHEMA [ <schema_name> ] } ]

Paramètres

LIKE 'pattern'

(Facultatif) Filtre la sortie de commande par nom d’objet. Le filtre utilise une concordance de motif insensible à la casse avec prise en charge des caractères génériques SQL (% et _).

Par exemple, les motifs suivants donnent les mêmes résultats :

... LIKE '%testing%' ...
... LIKE '%TESTING%' ...

. Par défaut : aucune valeur (aucun filtrage n’est appliqué à la sortie).

IN ACCOUNT | DATABASE [ db_name ] | SCHEMA [ schema_name ]

(Facultatif) Spécifie la portée de la commande, qui détermine si la commande répertorie les agents externes uniquement pour la base de données ou le schéma actuel/spécifié.

Si vous spécifiez le mot clé ACCOUNT, la commande récupère les enregistrements de tous les schémas de toutes les bases de données du compte courant.

Si vous spécifiez le mot clé DATABASE, alors :

  • Si vous spécifiez un db_name, la commande récupère les enregistrements de tous les schémas de la base de données spécifiée.

  • Si vous ne spécifiez pas de db_name, alors :

    • S’il existe une base de données actuelle, la commande récupère les enregistrements de tous les schémas de la base de données actuelle.

    • S’il n’y a pas de base de données actuelle, la commande récupère les enregistrements de toutes les bases de données et de tous les schémas du compte.

Si vous spécifiez le mot clé SCHEMA, alors :

  • Si vous spécifiez un nom de schéma qualifié (par exemple, my_database.my_schema), la commande récupère les enregistrements de la base de données et du schéma spécifiés.

  • Si vous spécifiez un schema_name non qualifié, alors :

    • S’il existe une base de données actuelle, la commande récupère les enregistrements du schéma spécifié dans la base de données actuelle.

    • S’il n’y a pas de base de données actuelle, la commande affiche l’erreur SQL compilation error: Object does not exist, or operation cannot be performed.

  • Si vous ne spécifiez pas de schema_name, alors :

    • S’il existe une base de données actuelle, alors :

      • S’il existe un schéma actuel, la commande récupère les enregistrements pour le schéma actuel dans la base de données actuelle.

      • S’il n’y a pas de schéma actuel, la commande récupère les enregistrements de tous les schémas de la base de données actuelle.

    • S’il n’y a pas de base de données actuelle, la commande récupère les enregistrements de toutes les bases de données et de tous les schémas du compte.

Par défaut : dépend si la session dispose actuellement d’une base de données en cours d’utilisation :

  • Base de données : DATABASE est la valeur par défaut (c’est-à-dire que la commande renvoie les agents externes que vous pouvez visualiser dans la base de données actuelle).

  • Aucune base de données : La portée du compte est définie par défaut (c’est-à-dire que la commande renvoie les agents externes que vous êtes autorisé à consulter dans votre compte).

Sortie

La sortie de commande fournit les propriétés des agents externes et les métadonnées dans les colonnes suivantes :

Colonne

Description

created_on

Horodatage de la création de l’agent externe.

name

Nom de l’agent externe.

database_name

Base de données contenant l’agent externe.

schema_name

Schéma contenant l’agent externe.

owner

Rôle qui possède l’agent externe.

comment

Commentaire pour l’agent externe.

versions

Tableau JSON qui répertorie les versions de l’agent externe.

default_version_name

Version par défaut de l’agent externe.

Exigences en matière de contrôle d’accès

Un rôle utilisé pour exécuter cette commande SQL doit avoir au moins l’un des privilèges suivants définis au minimum ainsi :

Privilège

Objet

Remarques

N’importe lequel de ces privilèges : OWNERSHIP, USAGE

Agent externe

Pour effectuer une opération sur un objet dans un schéma, il est nécessaire de disposer d’au moins un privilège sur la base de données parente et d’au moins un privilège sur le schéma parent.

Pour obtenir des instructions sur la création d’un rôle personnalisé avec un ensemble spécifique de privilèges, voir Création de rôles personnalisés.

Pour des informations générales sur les rôles et les privilèges accordés pour effectuer des actions SQL sur des objets sécurisables, voir Aperçu du contrôle d’accès.

Notes sur l’utilisation

  • La commande ne nécessite pas l’exécution d’un entrepôt en cours d’exécution.

  • La commande ne renvoie que les objets pour lesquels le rôle actuel de l’utilisateur s’est vu accorder au moins un privilège d’accès.

  • Le privilège d’accès MANAGE GRANTS permet implicitement à son titulaire de voir tous les objets du compte. Par défaut, seuls l’administrateur du compte (utilisateurs avec le rôle ACCOUNTADMIN) et l’administrateur de sécurité (utilisateurs avec le rôle SECURITYADMIN) ont le privilège MANAGE GRANTS.

  • Pour post-traiter la sortie de cette commande, vous pouvez utiliser l’opérateur de canal (->>) ou la fonction RESULT_SCAN. Les deux constructions traitent la sortie comme un jeu de résultats que vous pouvez interroger.

    Par exemple, vous pouvez utiliser l’opérateur de canal ou la fonction RESULT_SCAN pour sélectionner des colonnes spécifiques à partir de la sortie de la commande SHOW ou pour filtrer les lignes.

    Lorsque vous faites référence aux colonnes de sortie, utilisez des identificateurs entre guillemets doubles pour les noms des colonnes. Par exemple, pour sélectionner la colonne de sortie type, spécifiez SELECT "type".

    Vous devez utiliser des identificateurs entre guillemets doubles, car les noms des colonnes de sortie pour les commandes SHOW sont en minuscules. Les guillemets doubles garantissent que les noms des colonnes dans la liste SELECT ou dans la clause WHERE correspondent aux noms des colonnes dans la sortie de la commande SHOW qui a été analysée.

Exemples

Répertorier tous les agents externes dans le schéma actuel :

SHOW EXTERNAL AGENTS;

Répertorier les agents externes d’un schéma spécifique :

SHOW EXTERNAL AGENTS IN SCHEMA mydb.myschema;

Répertorier les agents externes d’une base de données spécifique :

SHOW EXTERNAL AGENTS IN DATABASE mydb;

Répertorier tous les agents externes du compte :

SHOW EXTERNAL AGENTS IN ACCOUNT;

Répertorier les agents externes dont les noms correspondent à un modèle :

SHOW EXTERNAL AGENTS LIKE 'my_rag%';