SHOW AGENTS

Répertorie les Agents Cortex pour lesquels vous disposez de privilèges d’accès.

Voir aussi :

CREATE AGENT, DROP AGENT, DESCRIBE AGENT

Syntaxe

SHOW AGENTS
  [ LIKE '<pattern>' ]
  [ IN { ACCOUNT | DATABASE <db_name> | SCHEMA [<db_name>.]<schema_name> } ]
  [ STARTS WITH '<string>' ]
  [ LIMIT <rows> [ FROM '<string_from>' ] ]
Copy

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 ... ]

Spécifie de manière facultative la portée de la commande. Spécifie l’un des éléments suivants :

ACCOUNT

Renvoie les enregistrements pour l’ensemble du compte.

DATABASE, . DATABASE db_name

Renvoie les enregistrements pour la base de données en cours d’utilisation ou pour une base de données spécifiée (db_name).

Si vous spécifiez DATABASE sans db_name et qu’aucune base de données n’est utilisée, le mot-clé n’a aucun effet sur la sortie.

Note

L’utilisation de commandes SHOW sans clause IN dans un contexte de base de données peut donner moins de résultats que prévu.

Les objets portant le même nom ne sont affichés qu’une seule fois si aucune clause IN n’est utilisée. Par exemple, si la table t1 se trouve dans schema1 et la table t1 dans schema2 et si elles sont toutes les deux dans le champ d’application du contexte de base de données que vous avez spécifié (c’est-à-dire, si la base de données que vous avez sélectionnée est le parent de schema1 et de schema2), SHOW TABLES n’affiche qu’une seule des tables t1.

SCHEMA, . SCHEMA schema_name

Renvoie les enregistrements pour le schéma en cours d’utilisation ou un schéma spécifié (schema_name).

SCHEMA est facultatif si une base de données est utilisée ou si vous spécifiez le schema_name complet (par exemple, db.schema).

Si aucune base de données n’est utilisée, spécifier SCHEMA n’a aucun effet sur la sortie.

Si vous omettez IN ..., la portée de la commande dépend de l’existence ou non d’une base de données en cours d’utilisation dans la session :

  • If a database is currently in use, the command returns the objects you have privileges to view in the database. This has the same effect as specifying IN DATABASE.

  • If no database is currently in use, the command returns the objects you have privileges to view in your account. This has the same effect as specifying IN ACCOUNT.

STARTS WITH 'name_string'

(Facultatif) Filtre la sortie de commande en fonction des caractères qui apparaissent au début du nom de l’objet. La chaîne doit être encadrée de guillemets simples et est sensible à la casse.

Par exemple, les chaînes suivantes renvoient des résultats différents :

... STARTS WITH 'B' ...
... STARTS WITH 'b' ...

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

LIMIT rows

(Facultatif) Limite le nombre maximum de lignes renvoyées. Le nombre réel de lignes renvoyées peut être inférieur à la limite spécifiée. Par exemple, le nombre d’objets existants est inférieur à la limite spécifiée.

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

Sortie

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

Colonne

Description

created_on

Horodatage de la création de l’agent.

name

Nom de l’agent.

database_name

Base de données contenant l’agent.

schema_name

Schéma contenant l’agent.

owner

Rôle du propriétaire de l’agent.

comment

Texte du commentaire pour l’agent.

profile

Profil d’agent JSON (display_name (nom d’affichage), avatar, couleur).

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, MONITOR ou OPERATE

Agent

Le privilège USAGE relatif à la base de données et au schéma parents est exigé pour effectuer des opérations sur tout objet d’un schéma. Notez qu’un rôle doté d’un privilège quelconque sur un schéma permet à ce rôle de résoudre le schéma. Par exemple, un rôle doté du privilège CREATE sur un schéma peut créer des objets sur ce schéma sans également avoir le privilège USAGE attribué sur ce schéma.

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.

    For example, you can use the pipe operator or RESULT_SCAN function to select specific columns from the SHOW command output or filter the rows.

    When you refer to the output columns, use double-quoted identifiers for the column names. For example, to select the output column type, specify SELECT "type".

    You must use double-quoted identifiers because the output column names for SHOW commands are in lowercase. The double quotes ensure that the column names in the SELECT list or WHERE clause match the column names in the SHOW command output that was scanned.

  • La commande renvoie un maximum de dix mille enregistrements pour le type d’objet spécifié, conformément aux privilèges d’accès du rôle utilisé pour exécuter la commande. Aucun enregistrement au-delà de la limite de dix mille enregistrements n’est renvoyé, même si un filtre a été appliqué.

    Pour afficher les résultats pour lesquels il existe plus de dix mille enregistrements, interrogez la vue correspondante (le cas échéant) dans Schéma d’information de Snowflake.

Exemples

Répertorier tous les agents du schéma actuel :

SHOW AGENTS;
Copy

Exemple de sortie :

+--------------+---------+---------------+-------------+-----------+-----------------------+-------------------------------------+
| created_on         | name  | database_name | schema_name | owner     | comment          | profile                            |
|--------------+---------+---------------+-------------+-----------+-----------------------+-------------------------------------|
| 2025-09-15 17:04:37.263 +0000 | TEST_AGENT | EXAMPLE_DB   | AGENTS | TEST_ROLE | null | {"display_name":"test"} |
+--------------+---------+---------------+-------------+-----------+-----------------------+-------------------------------------+

L’exemple suivant répertorie les agents d’un schéma spécifique :

SHOW AGENTS IN SCHEMA mydb.myschema;
Copy

L’exemple suivant répertorie les agents d’une base de données spécifique :

SHOW AGENTS IN DATABASE mydb;
Copy

L’exemple suivant répertorie tous les agents du compte :

SHOW AGENTS IN ACCOUNT;
Copy

L’exemple suivant répertorie les agents dont les noms commencent par my_agent :

SHOW AGENTS LIKE 'my_agent%';
Copy

L’exemple suivant répertorie les 10 premiers agents. La deuxième instruction répertorie les 10 premiers agents, à partir de l’agent nommé AGENT_NAME.

SHOW AGENTS LIMIT 10;
SHOW AGENTS LIMIT 10 FROM 'AGENT_NAME';
Copy

L’exemple suivant répertorie les agents en tant que ressources au format JSON :

SHOW AS RESOURCE AGENTS;
Copy