SHOW WORKSPACES

Lista os espaços de trabalho para os quais você tem privilégios de acesso. Cada espaço de trabalho está associado a um banco de dados e esquema específicos, permitindo acesso organizado e colaboração de dados.

Você pode usar este comando para listar os objetos no banco de dados e esquema atuais da sessão, em um banco de dados ou esquema especificado ou em toda a sua conta.

A saída inclui os metadados e as propriedades de cada objeto. Os objetos são classificados lexicograficamente por banco de dados, esquema e nome do objeto (consulte Saída neste tópico para obter descrições das colunas de saída). A ordem das linhas nos resultados é importante para filtrar os resultados.

Sintaxe

SHOW WORKSPACES [ LIKE '<pattern>' ]
                [ IN
                     {
                       ACCOUNT                  |

                       DATABASE                 |
                       DATABASE <database_name> |

                       SCHEMA                   |
                       SCHEMA <schema_name>     |
                       <schema_name>
                     }

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.

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 [ FROM 'name_string' ]

Opcionalmente, limita o número máximo de linhas retornadas, ao mesmo tempo em que permite a «paginação» dos resultados. 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.

A subcláusula opcional FROM 'name_string' serve efetivamente como um “cursor” para os resultados. Isso permite obter o número especificado de linhas seguindo a primeira linha cujo nome do objeto corresponde à cadeia de caracteres especificada:

  • A cadeia de caracteres deve ser colocada entre aspas simples e faz distinção entre letras maiúsculas e minúsculas.

  • A cadeia de caracteres não precisa incluir o nome completo do objeto; também é permitido usar nomes parciais.

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

Nota

Para comandos SHOW que oferecem suporte às cláusulas FROM 'name_string' e STARTS WITH 'name_string', você pode combinar ambas as cláusulas na mesma instrução. No entanto, ambas as condições devem ser cumpridas ou elas se cancelam mutuamente e nenhum resultado é retornado.

Além disso, os objetos são devolvidos em ordem lexicográfica por nome, portanto FROM 'name_string' só retorna linhas com um valor lexicográfico maior que as linhas retornadas por STARTS WITH 'name_string'.

Por exemplo:

  • ... STARTS WITH 'A' LIMIT ... FROM 'B' não retornaria nenhum resultado.

  • ... STARTS WITH 'B' LIMIT ... FROM 'A' não retornaria nenhum resultado.

  • ... STARTS WITH 'A' LIMIT ... FROM 'AB' retornariam resultados (se alguma linha corresponder às cadeias de caracteres de entrada).

Saída

A saída do comando inclui as seguintes colunas, que descrevem as propriedades e metadados do objeto:

Coluna

Descrição

name

Nome do objeto de espaço de trabalho.

database_name

Banco de dados no qual o espaço de trabalho está armazenado.

schema_name

Esquema no qual o espaço de trabalho está armazenado.

created_on

Data e hora em que o espaço de trabalho foi criado.

updated_on

Data e hora em que o espaço de trabalho foi atualizado pela última vez.

owner

Função proprietária do objeto de espaço de trabalho.

comment

Comentário para o objeto de espaço de trabalho.

Requisitos de controle de acesso

A função usada para executar essa operação deve ter, no mínimo, os seguintes privilégios:

Privilégio

Objeto

Notas

Qualquer privilégio (por exemplo, READ, WRITE ou OWNERSHIP)

Espaço de trabalho

Um espaço de trabalho aparecerá nos resultados se a função ativa tiver algum privilégio nele. OWNERSHIP é um privilégio especial em um objeto automaticamente concedido à função que criou o objeto, mas também pode ser transferido para uma função diferente usando o comando GRANT OWNERSHIP pela função de proprietário (ou qualquer função com o privilégio MANAGE GRANTS).

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.

    Por exemplo, é possível usar o operador de canal ou a função RESULT_SCAN para selecionar colunas específicas da saída do comando SHOW ou filtrar as linhas.

    Quando você fizer referência a colunas de saída, use identificadores entre aspas duplas para os nomes das colunas. Por exemplo, para selecionar a coluna de saída type, especifique SELECT "type".

    Você deve usar identificadores entre aspas duplas porque os nomes das colunas de saída para os comandos SHOW estão em minúsculas. As aspas duplas garantem que os nomes das colunas na lista SELECT ou na cláusula WHERE correspondam aos nomes das colunas na saída do comando SHOW que foi verificada.

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

  • Executar um comando para objetos em nível de esquema somente retornará um objeto se a função atual também tiver pelo menos um privilégio no banco de dados pai e no esquema.

Exemplos

O exemplo a seguir lista os espaços de trabalho que você tem privilégios para visualizar no esquema atual:

SHOW WORKSPACES;

O exemplo a seguir lista espaços de trabalho com nomes que começam com test:

SHOW WORKSPACES STARTS WITH 'test';