DESCRIBE DBT PROJECT

Décrit les propriétés d’un objet de projet dbt.

DESCRIBE peut être abrégé en DESC.

Voir aussi :

CREATE DBT PROJECT, ALTER DBT PROJECT, EXECUTE DBT PROJECT, DROP DBT PROJECT, SHOW DBT PROJECTS

Syntaxe

{ DESC | DESCRIBE } DBT PROJECT <name>
Copy

Paramètres

name

Indique l’identificateur de l’objet de projet à décrire.

Si l’identificateur contient des espaces ou des caractères spéciaux, toute la chaîne doit être délimitée par des guillemets doubles. Les identificateurs entre guillemets doubles sont également sensibles à la casse.

Pour plus d’informations, voir Exigences relatives à l’identificateur.

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

name

L’identificateur (nom) de l’objet de projet dbt.

owner

Le rôle qui a été utilisé pour créer l’objet de projet dbt.

comment

Le commentaire associé à l’objet de projet dbt.

default_target

La cible d’exécution par défaut (par exemple, prod ou dev) utilisée par les commandes dbt exécutées par Snowflake.

external_access_integrations

Le nom des intégrations d’accès externes que le projet dbt est autorisé à utiliser pour extraire des dépendances distantes du hub de paquets dbt ou de Github.

Les colonnes suivantes fournissent la valeur d’un paramètre obsolète :

default_version

The version of the dbt project object:

  • LAST: The most recent version of the dbt project object.

  • FIRST: The oldest version of the dbt project object.

default_version_name

L’identificateur de version au format VERSION$num, où num est un entier positif, par exemple : VERSION$1.

Le numéro de version commence à 1 lorsque vous créez un objet de projet dbt et augmente de un à chaque nouvelle version de l’objet de projet dbt.

Snowflake incrémente l’identificateur de version lorsque vous effectuez les tâches suivantes :

  • Redéployer un projet dbt depuis un espace de travail (exécute la commande ALTER avec l’option ADD VERSION).

  • Mettre à jour le projet en utilisant la commande ALTER DBT PROJECT.

  • Exécutez la commande Snow CLI snow dbt deploy avec l’option --force.

Snowflake réinitialise l’identificateur de version sur 1 et supprime tous les alias de version lorsque vous exécutez la commande CREATE DBT PROJECT avec l’option OR REPLACE.

default_version_alias

L’alias de nom de version personnalisé que vous avez créé pour une version spécifique de l’objet de projet dbt en utilisant la commande ALTER DBT VERSION avec l’option ADD PROJECT. Un alias de nom de version correspond toujours à un identificateur de version spécifique, tel que VERSION$3.

default_version_location_uri

L’URI d’emplacement de la version par défaut. En lecture seule.

default_version_source_location_uri

L’URI d’emplacement des fichiers sources de la version par défaut dans son objet Git. Si l’objet de projet dbt n’est pas connecté à un objet Git, cette valeur est nulle.

dbt_snowflake_version

The Snowflake version the dbt project object is on.

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

MONITOR

projet dbt

Pour effectuer une opération sur un objet dans un schéma, il est nécessaire de disposer d’au moins un privilège sur la base de données parente et d’au moins un privilège sur le schéma parent.

Pour obtenir des instructions sur la création d’un rôle personnalisé avec un ensemble spécifique de privilèges, voir Création de rôles personnalisés.

Pour des informations générales sur les rôles et les privilèges accordés pour effectuer des actions SQL sur des objets sécurisables, voir Aperçu du contrôle d’accès.

Notes sur l’utilisation

  • Pour post-traiter la sortie de cette commande, vous pouvez utiliser l’opérateur de canal (->>) ou la fonction RESULT_SCAN. Les deux constructions traitent la sortie comme un jeu de résultats que vous pouvez interroger.

    Par exemple, vous pouvez utiliser l’opérateur de canal ou la fonction RESULT_SCAN pour sélectionner des colonnes spécifiques à partir de la sortie de la commande SHOW ou pour filtrer les lignes.

    Lorsque vous faites référence aux colonnes de sortie, utilisez des identificateurs entre guillemets doubles pour les noms des colonnes. Par exemple, pour sélectionner la colonne de sortie type, spécifiez SELECT "type".

    Vous devez utiliser des identificateurs entre guillemets doubles, car les noms des colonnes de sortie pour les commandes SHOW sont en minuscules. Les guillemets doubles garantissent que les noms des colonnes dans la liste SELECT ou dans la clause WHERE correspondent aux noms des colonnes dans la sortie de la commande SHOW qui a été analysée.

Exemples

L’exemple suivant décrit l’objet de projet dbt nommé my_dbt_project :

DESCRIBE DBT PROJECT my_dbt_project;
Copy
+----------------+--------------+------------+-------------+-----------------+----------------------+-----------------------+---------------------------------------------------------------+-------------------------------------+-----------------------+----------------+------------------------------+
|      name      |    owner     |  comment   | dbt_version | default_version | default_version_name | default_version_alias | default_version_location_uri                                  | default_version_source_location_uri | dbt_snowflake_version | default_target | external_access_integrations |
+----------------+--------------+------------+-------------+-----------------+----------------------+-----------------------+---------------------------------------------------------------+-------------------------------------+-----------------------+----------------+------------------------------+
| my_dbt_project | ACCOUNTADMIN | My comment | 1.9.4b      | LAST            | VERSION$1            | null                  | snow://dbt/MY_DB.MY_SCHEMA.my_dbt_project/versions/version$1/ | @s1                                 | null                  | dev            | null                         |
+----------------+--------------+------------+-------------+-----------------+----------------------+-----------------------+---------------------------------------------------------------+-------------------------------------+-----------------------+----------------+------------------------------+