snow notebook create¶

Note

Beginning with version 3.4.0, Snowflake CLI added the snow notebook deploy command to replace the snow notebook create command. To support backward compatibility, you can still create a notebook using this command, but Snowflake recommends that you begin using the new Deploy and create a notebook procedure.

Creates notebook from stage.

Syntax¶

snow notebook create
  <identifier>
  --notebook-file <notebook_file>
  --connection <connection>
  --host <host>
  --port <port>
  --account <account>
  --user <user>
  --password <password>
  --authenticator <authenticator>
  --private-key-file <private_key_file>
  --token-file-path <token_file_path>
  --database <database>
  --schema <schema>
  --role <role>
  --warehouse <warehouse>
  --temporary-connection
  --mfa-passcode <mfa_passcode>
  --enable-diag
  --diag-log-path <diag_log_path>
  --diag-allowlist-path <diag_allowlist_path>
  --format <format>
  --verbose
  --debug
  --silent

Copy

Arguments¶

identifier: Identifier of the notebook; for example: MY_NOTEBOOK.

Options¶

--notebook-file, -f TEXT: Stage path with notebook file. For example @stage/path/to/notebook.ipynb.
--connection, -c, --environment TEXT: Name of the connection, as defined in your config.toml file. Default: default.
--host TEXT: Host address for the connection. Overrides the value specified for the connection.
--port INTEGER: Port for the connection. Overrides the value specified for the connection.
--account, --accountname TEXT: Name assigned to your Snowflake account. Overrides the value specified for the connection.
--user, --username TEXT: Username to connect to Snowflake. Overrides the value specified for the connection.
--password TEXT: Snowflake password. Overrides the value specified for the connection.
--authenticator TEXT: Snowflake authenticator. Overrides the value specified for the connection.
--private-key-file, --private-key-path TEXT: Snowflake private key file path. Overrides the value specified for the connection.
--token-file-path TEXT: Path to file with an OAuth token that should be used when connecting to Snowflake.
--database, --dbname TEXT: Database to use. Overrides the value specified for the connection.
--schema, --schemaname TEXT: Database schema to use. Overrides the value specified for the connection.
--role, --rolename TEXT: Role to use. Overrides the value specified for the connection.
--warehouse TEXT: Warehouse to use. Overrides the value specified for the connection.
--temporary-connection, -x: Uses connection defined with command line parameters, instead of one defined in config. Default: False.
--mfa-passcode TEXT: Token to use for multi-factor authentication (MFA).
--enable-diag: Run Python connector diagnostic test. Default: False.
--diag-log-path TEXT: Diagnostic report path. Default: <temporary_directory>.
--diag-allowlist-path TEXT: Diagnostic report path to optional allowlist.
--format [TABLE|JSON]: Specifies the output format. Default: TABLE.
--verbose, -v: Displays log entries for log levels info and higher. Default: False.
--debug: Displays log entries for log levels debug and higher; debug logs contain additional information. Default: False.
--silent: Turns off intermediate output to console. Default: False.

--help: Displays the help text for this command.

Usage notes¶

By default, the command creates notebooks using the default warehouse provided in the connection. You can use the --warehouse parameter to specify a different warehouse or to specify one if the connection does not include a warehouse.

Examples¶

The following example creates MY_NOTEBOOK from the staged @MY_STAGE/path/to/notebook.ipynb notebook:

snow notebook create MY_NOTEBOOK -f @MY_STAGE/path/to/notebook.ipynb

Copy