DESCRIBE DBT PROJECT

Describes the properties of a dbt project object.

DESCRIBE can be abbreviated to DESC.

See also:

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

Syntax

{ DESC | DESCRIBE } DBT PROJECT <name>
Copy

Parameters

name

Specifies the identifier for the dbt project object to describe.

If the identifier contains spaces or special characters, the entire string must be enclosed in double quotes. Identifiers enclosed in double quotes are also case-sensitive.

For more information, see Identifier requirements.

Output

The output of the command includes the following columns, which describe the properties and metadata of the object:

Column

Description

name

The identifier (name) of the dbt project object.

owner

The role that was used to create the dbt project object.

comment

The comment associated with the dbt project object.

Access control requirements

A role used to execute this operation must have the following privileges at a minimum:

Privilege

Object

MONITOR

dbt project

The USAGE privilege on the parent database and schema are required to perform operations on any object in a schema. Note that a role granted any privilege on a schema allows that role to resolve the schema. For example, a role granted CREATE privilege on a schema can create objects on that schema without also having USAGE granted on that schema.

For instructions on creating a custom role with a specified set of privileges, see Creating custom roles.

For general information about roles and privilege grants for performing SQL actions on securable objects, see Overview of Access Control.

Usage notes

  • To post-process the output of this command, you can use the pipe operator (->>) or the RESULT_SCAN function. Both constructs treat the output as a result set that you can query.

    For example, you can use the pipe operator or RESULT_SCAN function to select specific columns from the SHOW command output or filter the rows.

    When you refer to the output columns, use double-quoted identifiers for the column names. For example, to select the output column type, specify SELECT "type".

    You must use double-quoted identifiers because the output column names for SHOW commands are in lowercase. The double quotes ensure that the column names in the SELECT list or WHERE clause match the column names in the SHOW command output that was scanned.

Examples

The following example describes the dbt project object named my_dbt_project:

DESCRIBE DBT PROJECT my_dbt_project;
Copy
+----------------+--------------+------------+
|      name      |    owner     |  comment   |
+----------------+--------------+------------+
| my_dbt_project | ACCOUNTADMIN | My comment |
+----------------+--------------+------------+
Language: English