SHOW AGENTS¶

Lista o Cortex Agents para os quais você tem privilégios de acesso.

Consulte também:: CREATE AGENT, DROP AGENT, DESCRIBE AGENT

Sintaxe¶

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

Copy

Parâmetros¶

LIKE 'pattern'

Opcionalmente, filtra a saída do comando pelo nome do objeto. O filtro utiliza correspondência de padrão que não diferencia maiúsculas e minúsculas, com suporte para caracteres curinga SQL (% e _).

Por exemplo, os seguintes padrões retornam os mesmos resultados:

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

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

. padrão: sem valor (nenhuma filtragem é aplicada à saída).

[ IN ... ]

Opcionalmente, especifica o escopo do comando. Especifique um dos seguintes:

ACCOUNT

Retorna registros para toda a conta.

DATABASE, . DATABASE db_name

Retorna registros do banco de dados atual em uso ou de um banco de dados especificado (db_name).

Se você especificar DATABASE sem db_name e nenhum banco de dados estiver em uso, a palavra-chave não terá efeito sobre a saída.

Nota

Usar comandos SHOW sem uma cláusula IN em um contexto de banco de dados pode resultar em menos resultados do que o esperado.

Os objetos com o mesmo nome são exibidos apenas uma vez se não for usada a cláusula IN. Por exemplo, se a tabela t1 estiver em schema1 e a tabela t1 estiver em schema2 e ambas estiverem no escopo do contexto do banco de dados especificado (ou seja, o banco de dados selecionado é o pai de schema1 e schema2), então SHOW TABLES exibirá apenas uma das tabelas t1.

SCHEMA, . SCHEMA schema_name

Retorna registros do esquema atual em uso ou de um esquema especificado (schema_name).

SCHEMA é opcional se um banco de dados estiver em uso ou se você especificar o schema_name totalmente qualificado (por exemplo, db.schema).

Se nenhum banco de dados estiver em uso, a especificação SCHEMA não terá efeito sobre a saída.

Se você omitir IN ..., o escopo do comando dependerá se a sessão tem um banco de dados em uso:

Se um banco de dados estiver em uso no momento, o comando retornará os objetos que você tem privilégios para visualizar no banco de dados. Isso tem o mesmo efeito que especificar IN DATABASE.
Se nenhum banco de dados estiver em uso no momento, o comando retornará os objetos que você tem privilégios para visualizar na sua conta. Isso tem o mesmo efeito que especificar IN ACCOUNT.

STARTS WITH 'name_string'

Opcionalmente, filtra a saída do comando com base nos caracteres que aparecem no início do nome do objeto. A cadeia de caracteres deve ser colocada entre aspas simples e faz distinção entre letras maiúsculas e minúsculas.

Por exemplo, as seguintes cadeias de caracteres retornam resultados diferentes:

... STARTS WITH 'B' ...

... STARTS WITH 'b' ...

. Padrão: sem valor (nenhuma filtragem é aplicada à saída)

LIMIT rows

Opcionalmente, limita o número máximo de linhas retornadas. O número real de linhas retornadas pode ser menor que o limite especificado. Por exemplo, o número de objetos existentes é menor que o limite especificado.

Padrão: sem valor (nenhum limite é aplicado à saída).

Saída¶

A saída do comando fornece propriedades e metadados do Cortex Agent nas seguintes colunas:

Coluna	Descrição
`created_on`	Carimbo de data/hora em que o agente foi criado.
`name`	Nome do agente.
`database_name`	Banco de dados que contém o agente.
`schema_name`	Esquema contendo o agente.
`owner`	Função de proprietário do agente.
`comment`	Texto de comentário do agente.
`profile`	Perfil do agente JSON (nome_de_exibição, atalho, cor).

Requisitos de controle de acesso¶

Uma função usada para executar esse comando SQL deve ter pelo menos um dos seguintes privilégios, no mínimo:

Privilégio	Objeto	Notas
Qualquer um destes privilégios: OWNERSHIP, USAGE, MONITOR ou OPERATE	Agente

O privilégio USAGE no banco de dados e no esquema pai é necessário para executar operações em qualquer objeto de um esquema. Observe que uma função com privilégio concedido em um esquema permite que essa função resolva o esquema. Por exemplo, uma função com privilégio CREATE concedido em um esquema pode criar objetos nesse esquema sem também ter USAGE concedido nesse esquema.

Para instruções sobre como criar uma função personalizada com um conjunto específico de privilégios, consulte Criação de funções personalizadas.

Para informações gerais sobre concessões de funções e privilégios para executar ações de SQL em objetos protegíveis, consulte Visão geral do controle de acesso.

Notas de uso¶

O comando não precisa de um warehouse em funcionamento para ser executado.
O comando retorna apenas objetos para os quais a função atual do usuário atual recebeu pelo menos um privilégio de acesso.
O privilégio de acesso MANAGE GRANTS permite implicitamente que seu titular consulte todos os objetos da conta. Por padrão, somente o administrador de conta (usuários com a função ACCOUNTADMIN) e o administrador de segurança (usuários com a função SECURITYADMIN) têm o privilégio MANAGE GRANTS.

Para pós-processar a saída deste comando, você pode usar o operador de canal (->>) ou a função RESULT_SCAN. Ambos os constructos tratam a saída como um conjunto de resultados que você pode consultar.

Os nomes das colunas de saída para este comando são gerados em minúsculas. Se você consumir um conjunto de resultados deste comando com o operador de canal ou a função RESULT_SCAN, use identificadores entre aspas duplas para os nomes das colunas na consulta para garantir que eles correspondam aos nomes das colunas na saída que foi verificada. Por exemplo, se o nome de uma coluna de saída for type, especifique "type" para o identificador.

O comando retorna um máximo de dez mil registros para o tipo de objeto especificado, conforme ditado pelos privilégios de acesso da função usada para executar o comando. Todos os registros acima do limite de dez mil registros não são retornados, mesmo com um filtro aplicado.

Para visualizar os resultados para os quais existem mais de dez mil registros, consulte a exibição correspondente (se houver) em Snowflake Information Schema.

Exemplos¶

Listar todos os agentes no esquema atual:

SHOW AGENTS;

Copy

Exemplo de saída:

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

O exemplo a seguir lista os agentes em um esquema específico:

SHOW AGENTS IN SCHEMA mydb.myschema;

Copy

O exemplo a seguir lista os agentes em um banco de dados específico:

SHOW AGENTS IN DATABASE mydb;

Copy

O exemplo a seguir lista todos os agentes na conta:

SHOW AGENTS IN ACCOUNT;

Copy

O exemplo a seguir lista agentes com nomes que começam com my_agent:

SHOW AGENTS LIKE 'my_agent%';

Copy

O exemplo a seguir lista os primeiros 10 agentes. A segunda instrução lista os primeiros 10 agentes, iniciados a partir do agente denominado AGENT_NAME.

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

Copy

O exemplo a seguir lista agentes como recursos no JSON Formato:

SHOW AS RESOURCE AGENTS;

Copy