SHOW NOTEBOOKS¶

Lista os notebooks para os quais você tem privilégios de acesso.

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). É importante observar a ordem se você quiser filtrar os resultados.

Sintaxe¶

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

                       DATABASE                 |
                       DATABASE <database_name> |

                       SCHEMA                   |
                       SCHEMA <schema_name>     |
                       <schema_name>
                     }
               ]
               [ STARTS WITH '<name_string>' ]
               [ LIMIT <rows> ]
               [ LIMIT <rows> [ FROM '<name_string>' ] ]

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.

Padrão: depende se a sessão tem ou não um banco de dados em uso no momento:

Banco de dados: DATABASE é o padrão (ou seja, o comando retorna os objetos nos quais você tem privilégios para visualizar no banco de dados).

Sem banco de dados: ACCOUNT é o padrão (ou seja, o comando retorna os objetos que você tem privilégios de visualização em sua conta).

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 inclui as seguintes colunas, que descrevem as propriedades e metadados do objeto:

Coluna	Descrição
`created_on`	Data e hora em que o notebook foi criado.
`name`	Nome do objeto do notebook.
`database_name`	Banco de dados no qual o notebook está armazenado.
`schema_name`	Esquema no qual o notebook é armazenado.
`comment`	Comentário para o objeto do notebook.
`owner`	Função que possui o objeto do notebook.
`query_warehouse`	Warehouse onde as consultas emitidas no notebook são executadas.
`url_id`	ID exclusivo associado ao objeto do notebook.
`owner_role_type`	O tipo de função que possui o objeto, por exemplo `ROLE`. . Se um Snowflake Native App possui o objeto, o valor é `APPLICATION`. . Snowflake retorna NULL se você excluir o objeto porque um objeto excluído não tem uma função de proprietário.
`code_warehouse`	Warehouse onde o kernel do notebook é executado.

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
USAGE ou OWNERSHIP	Notebook	OWNERSHIP is a special privilege on an object that is automatically granted to the role that created the object, but can also be transferred using the GRANT OWNERSHIP command to a different role by the owning role (or any role with the MANAGE GRANTS privilege).

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 a função RESULT_SCAN, que trata a saída como uma tabela que pode ser consultada. Você também pode usar o operador de canal para consultar a saída desse comando.

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¶

O exemplo a seguir lista os notebooks que você tem privilégios para visualizar no esquema atual:

SHOW NOTEBOOKS;

Copy

O exemplo a seguir lista notebooks com nomes que começam com test:

SHOW NOTEBOOKS STARTS WITH 'test';

Copy

Retorna:

+--------------------------------+--------------+---------------+----------------------------------------------------------------------------------+--------+-----------------+----------------------+-----------------+------------------------------+
| created_on                     | name         | database_name | schema_name | comment                                                            | owner  | query_warehouse | url_id               | owner_role_type | code_warehouse               |
+--------------------------------+--------------+---------------+----------------------------------------------------------------------------------+--------+-----------------+----------------------+-----------------+------------------------------+
|  2024-03-20 06:37:08.402 +0000 | test_notebook| PUBLIC        | PUBLIC      | {"lastUpdatedUser":"309334439262","lastUpdatedTime":1711566800002} | PUBLIC | HLEVE1          | 2mbdchin3kn2tlzgqtca | ROLE            | SYSTEM$STREAMLIT_NOTEBOOK_WH |
+--------------------------------+--------------+---------------+-------------+--------------------------------------------------------------------+--------+-----------------+----------------------+-----------------+------------------------------+