SHOW AGENTS¶
Lists the Cortex Agents for which you have access privileges.
- See also:
Syntax¶
SHOW AGENTS
[ LIKE '<pattern>' ]
[ IN { ACCOUNT | DATABASE <db_name> | SCHEMA [<db_name>.]<schema_name> } ]
[ STARTS WITH '<string>' ]
[ LIMIT <rows> [ FROM '<string_from>' ] ]
Parameters¶
LIKE 'pattern'Optionally filters the command output by object name. The filter uses case-insensitive pattern matching, with support for SQL wildcard characters (
%and_).For example, the following patterns return the same results:
... LIKE '%testing%' ...... LIKE '%TESTING%' .... Default: No value (no filtering is applied to the output).
[ IN ... ]Optionally specifies the scope of the command. Specify one of the following:
ACCOUNTReturns records for the entire account.
DATABASE, .DATABASE db_nameReturns records for the current database in use or for a specified database (
db_name).If you specify
DATABASEwithoutdb_nameand no database is in use, the keyword has no effect on the output.Note
Using SHOW commands without an
INclause in a database context can result in fewer than expected results.Objects with the same name are only displayed once if no
INclause is used. For example, if you have tablet1inschema1and tablet1inschema2, and they are both in scope of the database context you’ve specified (that is, the database you’ve selected is the parent ofschema1andschema2), then SHOW TABLES only displays one of thet1tables.SCHEMA, .SCHEMA schema_nameReturns records for the current schema in use or a specified schema (
schema_name).SCHEMAis optional if a database is in use or if you specify the fully qualifiedschema_name(for example,db.schema).If no database is in use, specifying
SCHEMAhas no effect on the output.
If you omit
IN ..., the scope of the command depends on whether the session currently has a database in use: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 specifiying
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 specifiying
IN ACCOUNT.
STARTS WITH 'name_string'Optionally filters the command output based on the characters that appear at the beginning of the object name. The string must be enclosed in single quotes and is case sensitive.
For example, the following strings return different results:
... STARTS WITH 'B' ...... STARTS WITH 'b' .... Default: No value (no filtering is applied to the output)
LIMIT rowsOptionally limits the maximum number of rows returned. The actual number of rows returned might be less than the specified limit. For example, the number of existing objects is less than the specified limit.
Default: No value (no limit is applied to the output).
Output¶
The command output provides Cortex Agent properties and metadata in the following columns:
Column |
Description |
|---|---|
|
Timestamp when the agent was created. |
|
Name of the agent. |
|
Database containing the agent. |
|
Schema containing the agent. |
|
Owner role of the agent. |
|
Comment text for the agent. |
|
Agent profile JSON (display_name, avatar, color). |
Access control requirements¶
A role used to execute this SQL command must have at least one of the following privileges at a minimum:
Privilege |
Object |
Notes |
|---|---|---|
Any one of these privileges: OWNERSHIP, USAGE, MONITOR or OPERATE |
Agent |
The USAGE privilege on the parent database and schema are required to perform operations on any object in a schema. Note that a role granted any privilege on a schema allows that role to resolve the schema. For example, a role granted CREATE privilege on a schema can create objects on that schema without also having USAGE granted on that schema.
For instructions on creating a custom role with a specified set of privileges, see Creating custom roles.
For general information about roles and privilege grants for performing SQL actions on securable objects, see Overview of Access Control.
Usage notes¶
The command doesn’t require a running warehouse to execute.
The command only returns objects for which the current user’s current role has been granted at least one access privilege.
The MANAGE GRANTS access privilege implicitly allows its holder to see every object in the account. By default, only the account administrator (users with the ACCOUNTADMIN role) and security administrator (users with the SECURITYADMIN role) have the MANAGE GRANTS privilege.
To post-process the output of this command, you can use the pipe operator (
->>) or the RESULT_SCAN function. Both constructs treat the output as a result set that you can query.The output column names for this command are generated in lowercase. If you consume a result set from this command with the pipe operator or the RESULT_SCAN function, use double-quoted identifiers for the column names in the query to ensure that they match the column names in the output that was scanned. For example, if the name of an output column is
type, then specify"type"for the identifier.
The command returns a maximum of ten thousand records for the specified object type, as dictated by the access privileges for the role used to execute the command. Any records above the ten thousand records limit aren’t returned, even with a filter applied.
To view results for which more than ten thousand records exist, query the corresponding view (if one exists) in the Snowflake Information Schema.
Examples¶
List all agents in the current schema:
SHOW AGENTS;
Sample output:
+--------------+---------+---------------+-------------+-----------+-----------------------+-------------------------------------+
| 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"} |
+--------------+---------+---------------+-------------+-----------+-----------------------+-------------------------------------+
The following example lists agents in a specific schema:
SHOW AGENTS IN SCHEMA mydb.myschema;
The following example lists agents in a specific database:
SHOW AGENTS IN DATABASE mydb;
The following example lists all agents in the account:
SHOW AGENTS IN ACCOUNT;
The following example lists agents with names that start with my_agent:
SHOW AGENTS LIKE 'my_agent%';
The following example lists the first 10 agents. The second statement lists the first 10 agents, started from the agent named AGENT_NAME.
SHOW AGENTS LIMIT 10;
SHOW AGENTS LIMIT 10 FROM 'AGENT_NAME';
The following example lists agents as resources in JSON format:
SHOW AS RESOURCE AGENTS;