SHOW NOTEBOOKS¶

Répertorie les notebooks pour lesquels vous avez des privilèges d’accès.

Vous pouvez utiliser cette commande pour répertorier les objets de la base de données et du schéma actuels de la session, d’une base de données ou d’un schéma spécifique ou de l’ensemble de votre compte.

La sortie comprend les métadonnées et les propriétés de chaque objet. Les objets sont triés lexicographiquement par nom de base de données, de schéma et d’objet (voir Sortie dans cette rubrique pour la description des colonnes de sortie). L’ordre est important à noter si vous souhaitez filtrer les résultats.

Syntaxe¶

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

Paramètres¶

LIKE 'pattern'
(Facultatif) Filtre la sortie de commande par nom d’objet. Le filtre utilise une concordance de motif insensible à la casse avec prise en charge des caractères génériques SQL (% et _).

Par exemple, les motifs suivants donnent les mêmes résultats :

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

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

. Par défaut : aucune valeur (aucun filtrage n’est appliqué à la sortie).

[ IN ... ]
Spécifie de manière facultative la portée de la commande. Spécifie l’un des éléments suivants :

ACCOUNT
Renvoie les enregistrements pour l’ensemble du compte.

DATABASE, . DATABASE db_name
Renvoie les enregistrements pour la base de données en cours d’utilisation ou pour une base de données spécifiée (db_name).

Si vous spécifiez DATABASE sans db_name et qu’aucune base de données n’est utilisée, le mot-clé n’a aucun effet sur la sortie.

Note

L’utilisation de commandes SHOW sans clause IN dans un contexte de base de données peut donner moins de résultats que prévu.

Les objets portant le même nom ne sont affichés qu’une seule fois si aucune clause IN n’est utilisée. Par exemple, si la table t1 se trouve dans schema1 et la table t1 dans schema2 et si elles sont toutes les deux dans le champ d’application du contexte de base de données que vous avez spécifié (c’est-à-dire, si la base de données que vous avez sélectionnée est le parent de schema1 et de schema2), SHOW TABLES n’affiche qu’une seule des tables t1.

SCHEMA, . SCHEMA schema_name
Renvoie les enregistrements pour le schéma en cours d’utilisation ou un schéma spécifié (schema_name).

SCHEMA est facultatif si une base de données est utilisée ou si vous spécifiez le schema_name complet (par exemple, db.schema).

Si aucune base de données n’est utilisée, spécifier SCHEMA n’a aucun effet sur la sortie.

Par défaut : dépend si la session dispose actuellement d’une base de données en cours d’utilisation :

Base de données : DATABASE est la valeur par défaut (c’est-à-dire que la commande renvoie les objets que vous pouvez visualiser dans la base de données).

Aucune base de données : ACCOUNT est la valeur par défaut (c’est-à-dire que la commande renvoie les objets que vous pouvez visualiser dans votre compte).

STARTS WITH 'name_string'
(Facultatif) Filtre la sortie de commande en fonction des caractères qui apparaissent au début du nom de l’objet. La chaîne doit être encadrée de guillemets simples et est sensible à la casse.

Par exemple, les chaînes suivantes renvoient des résultats différents :

... STARTS WITH 'B' ...

... STARTS WITH 'b' ...

. Par défaut : aucune valeur (aucun filtrage n’est appliqué à la sortie)

LIMIT rows
(Facultatif) Limite le nombre maximum de lignes renvoyées. Le nombre réel de lignes renvoyées peut être inférieur à la limite spécifiée. Par exemple, le nombre d’objets existants est inférieur à la limite spécifiée.

Par défaut : aucune valeur (aucune limite n’est appliquée à la sortie).

Sortie¶

La sortie de la commande comprend les colonnes suivantes, qui décrivent les propriétés et les métadonnées de l’objet :

Colonne	Description
`created_on`	Date et heure de création du notebook.
`name`	Nom de l’objet de notebook.
`database_name`	Base de données dans laquelle le notebook est stocké.
`schema_name`	Schéma dans lequel le notebook est stocké.
`comment`	Commentaire sur l’objet de notebook.
`owner`	Rôle propriétaire de l’objet de notebook.
`query_warehouse`	Entrepôt dans lequel sont exécutées les requêtes émises dans le notebook.
`url_id`	ID unique associé à l’objet de notebook.
`owner_role_type`	Type de rôle qui possède l’objet, par exemple `ROLE`. . Si une Snowflake Native App est propriétaire de l’objet, la valeur est `APPLICATION`. . Snowflake renvoie NULL si vous supprimez l’objet, car un objet supprimé n’a pas de rôle propriétaire.
`code_warehouse`	Entrepôt dans lequel est exécuté le noyau du notebook.

Exigences en matière de contrôle d’accès¶

Un rôle utilisé pour exécuter cette opération doit au minimum disposer des privilèges suivants :

Privilège	Objet	Remarques
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).

Notes sur l’utilisation¶

La commande ne nécessite pas l’exécution d’un entrepôt en cours d’exécution.
La commande ne renvoie que les objets pour lesquels le rôle actuel de l’utilisateur s’est vu accorder au moins un privilège d’accès.
Le privilège d’accès MANAGE GRANTS permet implicitement à son titulaire de voir tous les objets du compte. Par défaut, seuls l’administrateur du compte (utilisateurs avec le rôle ACCOUNTADMIN) et l’administrateur de sécurité (utilisateurs avec le rôle SECURITYADMIN) ont le privilège MANAGE GRANTS.

Pour post-traiter la sortie de cette commande, vous pouvez utiliser la fonction RESULT_SCAN qui traite la sortie sous forme de table à interroger. Vous pouvez également utiliser l”opérateur de canal pour interroger la sortie de cette commande.

La commande renvoie un maximum de dix mille enregistrements pour le type d’objet spécifié, conformément aux privilèges d’accès du rôle utilisé pour exécuter la commande. Aucun enregistrement au-delà de la limite de dix mille enregistrements n’est renvoyé, même si un filtre a été appliqué.

Pour afficher les résultats pour lesquels il existe plus de dix mille enregistrements, interrogez la vue correspondante (le cas échéant) dans Schéma d’information de Snowflake.

Exemples¶

L’exemple suivant répertorie les notebooks que vous avez le privilège d’afficher dans le schéma actuel :

SHOW NOTEBOOKS;

Copy

L’exemple suivant dresse la liste des notebooks dont les noms commencent par test :

SHOW NOTEBOOKS STARTS WITH 'test';

Copy

Renvoie :

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