SHOW-AGENTS

Listet die Cortex Agents auf, für die Sie Zugriffsrechte haben.

Siehe auch:

CREATE-AGENT, DROP-AGENT, DESCRIBE-AGENT

Syntax

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

Parameter

LIKE 'pattern'

Filtert optional die Befehlsausgabe nach dem Objektnamen. Der Filter verwendet einen Musterabgleich ohne Berücksichtigung der Groß-/Kleinschreibung, aber mit Unterstützung von SQL-Platzhalterzeichen (% und _).

Die folgenden Muster geben beispielsweise die gleichen Ergebnisse zurück:

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

. Standard: Kein Wert (die Ausgabe wird nicht gefiltert).

[ IN ... ]

Gibt optional den Geltungsbereich des Befehls an. Geben Sie eine der folgenden Optionen an:

ACCOUNT

Gibt Datensätze für das gesamte Konto zurück.

DATABASE, . DATABASE db_name

Gibt Datensätze für die aktuell verwendete Datenbank oder eine angegebene Datenbank (db_name) zurück.

Wenn Sie DATABASE ohne db_name angeben und aktuell keine Datenbank in Verwendung ist, hat das Schlüsselwort keine Auswirkungen auf die Ausgabe.

Bemerkung

Die Verwendung von SHOW-Befehlen ohne eine IN-Klausel in einem Datenbankkontext kann zu weniger Ergebnissen als erwartet führen.

Objekte mit demselben Namen werden nur einmal angezeigt, wenn keine IN-Klausel verwendet wird. Wenn Sie z. B. die Tabelle t1 in schema1 und die Tabelle t1 in schema2 haben und beide im Geltungsbereich des von Ihnen angegebenen Datenbankkontextes liegen (d. h. die von Ihnen ausgewählte Datenbank ist die übergeordnete Datenbank von schema1 und schema2), dann zeigt SHOW TABLES nur eine der t1-Tabellen an.

SCHEMA, . SCHEMA schema_name

Gibt Datensätze für das aktuell verwendete Schema oder ein angegebenes Schema (schema_name) zurück.

SCHEMA ist optional, wenn aktuell eine Datenbank in Verwendung ist oder wenn Sie für schema_name den vollqualifizierten Schemanamen (z. B. db.schema) angeben.

Wenn aktuell keine Datenbank in Verwendung ist, hat die Angabe von SCHEMA keine Auswirkungen auf die Ausgabe.

Wenn Sie IN ... weglassen, hängt der Geltungsbereich des Befehls davon ab, ob für die Sitzung aktuell eine Datenbank in Verwendung ist:

  • Wenn aktuell eine Datenbank verwendet wird, gibt der Befehl die Objekte zurück, für die Sie Berechtigungen zum Anzeigen in der Datenbank haben. Dies hat die gleiche Wirkung wie die Angabe von IN DATABASE.

  • Wenn aktuell keine Datenbank verwendet wird, gibt der Befehl die Objekte zurück, für die Sie Berechtigungen zum Anzeigen in Ihrem Konto haben. Dies hat die gleiche Wirkung wie die Angabe von IN ACCOUNT.

STARTS WITH 'name_string'

Filtert die Befehlsausgabe optional anhand der Zeichen, die am Anfang des Objektnamens angezeigt werden. Die Zeichenfolge muss in einfache Anführungszeichen gesetzt werden, wobei zwischen Groß-/Kleinschreibung unterschieden wird.

Die folgenden Zeichenfolgen geben beispielsweise unterschiedliche Ergebnisse zurück:

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

. Standard: Kein Wert (die Ausgabe wird nicht gefiltert)

LIMIT rows

Begrenzt optional die maximale Anzahl der zurückgegebenen Zeilen. Die tatsächliche Anzahl der zurückgegebenen Zeilen kann geringer sein als das angegebene Limit. Beispielsweise ist die Anzahl der vorhandenen Objekte geringer als das angegebene Limit.

Standard: Kein Wert (die Ausgabe wird nicht begrenzt).

Ausgabe

Die Befehlsausgabe enthält Eigenschaften und Metadaten von Cortex Agent in den folgenden Spalten:

Spalte

Beschreibung

created_on

Zeitstempel, wann der Agent erstellt wurde.

name

Name des Agenten.

database_name

Datenbank, die den Agenten enthält.

schema_name

Schema, das den Agenten enthält.

owner

Eigentümerrolle des Agenten.

comment

Kommentartext für den Agenten.

profile

Profil des Agenten JSON (display_name, Avatar, Farbe).

Anforderungen an die Zugriffssteuerung

Eine Rolle, die zur Ausführung dieses SQL-Befehls verwendet wird, muss mindestens eine der folgenden Berechtigungen haben:

Berechtigung

Objekt

Anmerkungen

Jede dieser Berechtigungen: OWNERSHIP, USAGE, MONITOR oder OPERATE

Agent

USAGE-Berechtigung für die übergeordnete Datenbank und das Schema ist erforderlich, um Operationen an einem beliebigen Objekt in einem Schema durchzuführen. Beachten Sie, dass eine Rolle, die eine beliebige Berechtigung für ein Schema erhalten hat, es dieser Rolle erlaubt, das Schema aufzulösen. Zum Beispiel kann eine Rolle, der die CREATE-Berechtigung für ein Schema gewährt wurde, Objekte in diesem Schema erstellen, ohne auch USAGE für dieses Schema gewährt bekommen zu haben.

Eine Anleitung zum Erstellen einer kundenspezifischen Rolle mit einer bestimmten Gruppe von Berechtigungen finden Sie unter Erstellen von kundenspezifischen Rollen.

Allgemeine Informationen zu Rollen und Berechtigungen zur Durchführung von SQL-Aktionen auf sicherungsfähigen Objekten finden Sie unter Übersicht zur Zugriffssteuerung.

Nutzungshinweise

  • Für die Ausführung des Befehls ist kein aktives Warehouse erforderlich.

  • Der Befehl gibt nur Objekte zurück, für die der aktuellen Rolle des aktuellen Benutzers mindestens ein Zugriffsrecht zugewiesen wurde.

  • Das Zugriffsrecht MANAGE GRANTS gibt seinem Eigentümer implizit die Möglichkeit, jedes Objekt im Konto anzuzeigen. Standardmäßig haben nur der Kontoadministrator (Benutzer mit der Rolle ACCOUNTADMIN) und der Systemadministrator (Benutzer mit der Rolle SECURITYADMIN) die Berechtigung MANAGE GRANTS.

  • Um die Ausgabe dieses Befehls nachzubearbeiten, können Sie den Befehl Pipe-Operator (->>) oder die RESULT_SCAN-Funktion verwenden. Beide Konstrukte behandeln die Ausgabe als Resultset, das Sie abfragen können.

    Die Namen der Ausgabespalten für diesen Befehl werden in Kleinbuchstaben generiert. Wenn Sie ein Resultset aus diesem Befehl mit dem Pipe-Operator oder der RESULT_SCAN-Funktion verbrauchen, verwenden Sie Bezeichner mit doppelten Anführungszeichen für die Spaltennamen in der Abfrage, um sicherzustellen, dass sie mit den Spaltennamen in der gescannten Ausgabe übereinstimmen. Wenn der Name einer Ausgabespalte beispielsweise type lautet, geben Sie "type" für den Bezeichner an.

  • Der Befehl gibt maximal zehntausend Datensätze für den angegebenen Objekttyp zurück, entsprechend den Zugriffsrechten für die zur Ausführung des Befehls verwendete Rolle. Datensätze, die die Grenze von zehntausend Datensätzen überschreiten, werden nicht zurückgegeben, selbst wenn ein Filter angewendet wurde.

    Um Ergebnisse anzuzeigen, für die mehr als zehntausend Datensätze existieren, fragen Sie die entsprechende Ansicht (sofern vorhanden) in Snowflake Information Schema ab.

Beispiele

Listen Sie alle Agenten im aktuellen Schema auf:

SHOW AGENTS;
Copy

Beispielausgabe:

+--------------+---------+---------------+-------------+-----------+-----------------------+-------------------------------------+
| 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"} |
+--------------+---------+---------------+-------------+-----------+-----------------------+-------------------------------------+

Das folgende Beispiel listet die Agenten in einem bestimmten Schema auf:

SHOW AGENTS IN SCHEMA mydb.myschema;
Copy

Das folgende Beispiel listet die Agenten in einer bestimmten Datenbank auf:

SHOW AGENTS IN DATABASE mydb;
Copy

Im folgenden Beispiel werden alle Agenten im Konto aufgelistet:

SHOW AGENTS IN ACCOUNT;
Copy

Das folgende Beispiel listet Agenten auf, deren Namen mit my_agent beginnen:

SHOW AGENTS LIKE 'my_agent%';
Copy

Im folgenden Beispiel werden die ersten 10 Agenten aufgelistet. Die zweite Anweisung listet die ersten 10 Agenten auf, die von dem Agenten namens AGENT_NAME gestartet wurden.

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

Im folgenden Beispiel werden Agenten als Ressourcen im JSON-Format aufgelistet:

SHOW AS RESOURCE AGENTS;
Copy