DESCRIBE NOTEBOOK¶

Describes the properties of a notebook.

DESCRIBE can be abbreviated to DESC.

Syntax¶

{ DESC | DESCRIBE } NOTEBOOK <name>
Copy

Parameters¶

name

Specifies the identifier for the notebook 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

created_on

Date and time when the notebook was created.

Access control requirements¶

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

Privilege

Object

Notes

USAGE or OWNERSHIP

Notebook

OWNERSHIP is a special privilege on an object that is automatically granted to the role that created the object. Notebook ownerships cannot be transferred.

Usage notes¶

  • To post-process the output of this command, you can use the RESULT_SCAN function, which treats the output as a table that can be queried.

Examples¶

The following example describes the notebook named mybook:

DESCRIBE NOTEBOOK mybook;
Copy