notebooks

Creates, updates, deletes, gets or lists a notebooks resource.

Overview

Name	notebooks
Type	Resource
Id	snowflake.apps.notebooks

Fields

The following fields are returned by SELECT queries:

get

successful

Name	Datatype	Description
name	string	Name of the notebook (pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$)
url_id	string	Unique ID associated with the notebook object.
database_name	string	Database in which the notebook is stored (pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$)
runtime_name	string	The runtime to run the Streamlit or Notebook on. If this is not set, the warehouse is assumed
schema_name	string	Schema in which the notebook is stored (pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$)
budget	string	Name of the budget if the notebook is monitored by a budget (pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$)
comment	string	user comment associated to an object in the dictionary
compute_pool	string	Compute pool name where the snowservice runs
created_on	string (date-time)	Date and time when the notebook was created.
default_packages	string	Default packages of the notebook
default_version	string	The default version name of a file based entity.
default_version_details	object	The version details of a file based entity
external_access_integrations	array	List of external access integrations attached to this function
external_access_secrets	string	Secrets to be used with this function for external access
fromLocation	string	Location to copy the file from. This must be a Snowflake stage location.
idle_auto_shutdown_time_seconds	integer (int64)	Sets the time in seconds for when to shutdown an idle Notebook.
import_urls	array	List of urls
last_version_details	object	The version details of a file based entity
live_version_location_uri	string	The current version location
main_file	string	Name + path of the file for the Notebook
owner	string	Role that owns the notebook (pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$)
owner_role_type	string	The type of role that owns the notebook (pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$)
query_warehouse	string	Warehouse against which the queries issued by the Streamlit app are run against
title	string	User facing title of the Streamlit app or an Organization Profile
user_packages	string	User packages of the notebook
version	string	User specified version alias

list

A Snowflake notebook

Name	Datatype	Description
name	string	Name of the notebook (pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$)
url_id	string	Unique ID associated with the notebook object.
database_name	string	Database in which the notebook is stored (pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$)
runtime_name	string	The runtime to run the Streamlit or Notebook on. If this is not set, the warehouse is assumed
schema_name	string	Schema in which the notebook is stored (pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$)
budget	string	Name of the budget if the notebook is monitored by a budget (pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$)
comment	string	user comment associated to an object in the dictionary
compute_pool	string	Compute pool name where the snowservice runs
created_on	string (date-time)	Date and time when the notebook was created.
default_packages	string	Default packages of the notebook
default_version	string	The default version name of a file based entity.
default_version_details	object	The version details of a file based entity
external_access_integrations	array	List of external access integrations attached to this function
external_access_secrets	string	Secrets to be used with this function for external access
fromLocation	string	Location to copy the file from. This must be a Snowflake stage location.
idle_auto_shutdown_time_seconds	integer (int64)	Sets the time in seconds for when to shutdown an idle Notebook.
import_urls	array	List of urls
last_version_details	object	The version details of a file based entity
live_version_location_uri	string	The current version location
main_file	string	Name + path of the file for the Notebook
owner	string	Role that owns the notebook (pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$)
owner_role_type	string	The type of role that owns the notebook (pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$)
query_warehouse	string	Warehouse against which the queries issued by the Streamlit app are run against
title	string	User facing title of the Streamlit app or an Organization Profile
user_packages	string	User packages of the notebook
version	string	User specified version alias

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	database_name, schema_name, name, endpoint		Fetch a notebook
list	select	database_name, schema_name, endpoint	like, startsWith, showLimit, fromName	List notebooks
create	insert	database_name, schema_name, endpoint, name	createMode	Create a notebook
delete	delete	database_name, schema_name, name, endpoint	ifExists	Delete a notebook
execute	exec	database_name, schema_name, name, endpoint	asyncExec	Execute a Notebook
rename	exec	database_name, schema_name, name, targetName, endpoint	ifExists, targetDatabase, targetSchema	Changes the name of the notebook to new name. The new identifier must be unique for the schema.
add_live_version	exec	database_name, schema_name, name, endpoint	fromLast, comment	Adds a LIVE version to the notebook
commit	exec	database_name, schema_name, name, endpoint	version, comment	If a Git connection is set up for the notebook, commits the LIVE version of the notebook to the Git repository

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
database_name	string	Identifier (i.e. name) for the database to which the resource belongs. You can use the /api/v2/databases GET request to get a list of available databases.
endpoint	string	Organization and account identifier (orgname-accountname) (default: orgname-accountname)
name	string	Identifier (i.e. name) for the resource.
schema_name	string	Identifier (i.e. name) for the schema to which the resource belongs. You can use the /api/v2/databases/{database}/schemas GET request to get a list of available schemas for the specified database.
targetName	string	Name of the target resource.
asyncExec	boolean	Asynchronous execution enable/disable. Default is disable.
comment	string	Sets a comment for the notebook or version of the notebook
createMode	string	Parameter allowing support for different modes of resource creation. Possible values include: - errorIfExists: Throws an error if you try to create a resource that already exists. - orReplace: Automatically replaces the existing resource with the current one. - ifNotExists: Creates a new resource when an alter is requested for a non-existent resource.
fromLast	boolean	Sets the LIVE version to the LAST version of the notebook
fromName	string	Parameter to enable fetching rows only following the first row whose object name matches the specified string. Case-sensitive and does not have to be the full name.
ifExists	boolean	Parameter that specifies how to handle the request for a resource that does not exist: - true: The endpoint does not throw an error if the resource does not exist. It returns a 200 success response, but does not take any action on the resource. - false: The endpoint throws an error if the resource doesn't exist.
like	string	Parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters.
showLimit	integer	Parameter to limit the maximum number of rows returned by a command.
startsWith	string	Parameter to filter the command output based on the string of characters that appear at the beginning of the object name. Uses case-sensitive pattern matching.
targetDatabase	string	Database of the target resource. Defaults to the source's database
targetSchema	string	Schema of the target resource. Defaults to the source's schema
version	string	live version of the alias

SELECT examples

get

Fetch a notebook

SELECT
name,
url_id,
database_name,
runtime_name,
schema_name,
budget,
comment,
compute_pool,
created_on,
default_packages,
default_version,
default_version_details,
external_access_integrations,
external_access_secrets,
fromLocation,
idle_auto_shutdown_time_seconds,
import_urls,
last_version_details,
live_version_location_uri,
main_file,
owner,
owner_role_type,
query_warehouse,
title,
user_packages,
version
FROM snowflake.apps.notebooks
WHERE database_name = '{{ database_name }}' -- required
AND schema_name = '{{ schema_name }}' -- required
AND name = '{{ name }}' -- required
AND endpoint = '{{ endpoint }}' -- required
;

list

List notebooks

SELECT
name,
url_id,
database_name,
runtime_name,
schema_name,
budget,
comment,
compute_pool,
created_on,
default_packages,
default_version,
default_version_details,
external_access_integrations,
external_access_secrets,
fromLocation,
idle_auto_shutdown_time_seconds,
import_urls,
last_version_details,
live_version_location_uri,
main_file,
owner,
owner_role_type,
query_warehouse,
title,
user_packages,
version
FROM snowflake.apps.notebooks
WHERE database_name = '{{ database_name }}' -- required
AND schema_name = '{{ schema_name }}' -- required
AND endpoint = '{{ endpoint }}' -- required
AND "like" = '{{ like }}'
AND startsWith = '{{ startsWith }}'
AND showLimit = '{{ showLimit }}'
AND fromName = '{{ fromName }}'
;

INSERT examples

create

Create a notebook

INSERT INTO snowflake.apps.notebooks (
name,
version,
fromLocation,
main_file,
comment,
default_version,
query_warehouse,
database_name,
schema_name,
endpoint,
createMode
)
SELECT 
'{{ name }}' /* required */,
'{{ version }}',
'{{ fromLocation }}',
'{{ main_file }}',
'{{ comment }}',
'{{ default_version }}',
'{{ query_warehouse }}',
'{{ database_name }}',
'{{ schema_name }}',
'{{ endpoint }}',
'{{ createMode }}'
RETURNING
status
;

Manifest

# Description fields are for documentation purposes
- name: notebooks
props:
  - name: database_name
    value: "{{ database_name }}"
    description: Required parameter for the notebooks resource.
  - name: schema_name
    value: "{{ schema_name }}"
    description: Required parameter for the notebooks resource.
  - name: endpoint
    value: "{{ endpoint }}"
    description: Required parameter for the notebooks resource.
  - name: name
    value: "{{ name }}"
    description: |
      Name of the notebook
  - name: version
    value: "{{ version }}"
    description: |
      User specified version alias
  - name: fromLocation
    value: "{{ fromLocation }}"
    description: |
      Location to copy the file from. This must be a Snowflake stage location.
  - name: main_file
    value: "{{ main_file }}"
    description: |
      Name + path of the file for the Notebook
  - name: comment
    value: "{{ comment }}"
    description: |
      user comment associated to an object in the dictionary
  - name: default_version
    value: "{{ default_version }}"
    description: |
      The default version name of a file based entity.
  - name: query_warehouse
    value: "{{ query_warehouse }}"
    description: |
      Warehouse against which the queries issued by the Streamlit app are run against
  - name: createMode
    value: "{{ createMode }}"
    description: Parameter allowing support for different modes of resource creation. Possible values include: - `errorIfExists`: Throws an error if you try to create a resource that already exists. - `orReplace`: Automatically replaces the existing resource with the current one. - `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource.
    description: Parameter allowing support for different modes of resource creation. Possible values include: - `errorIfExists`: Throws an error if you try to create a resource that already exists. - `orReplace`: Automatically replaces the existing resource with the current one. - `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource.

DELETE examples

delete

Delete a notebook

DELETE FROM snowflake.apps.notebooks
WHERE database_name = '{{ database_name }}' --required
AND schema_name = '{{ schema_name }}' --required
AND name = '{{ name }}' --required
AND endpoint = '{{ endpoint }}' --required
AND ifExists = '{{ ifExists }}'
;

Lifecycle Methods

execute

Execute a Notebook

EXEC snowflake.apps.notebooks.execute 
@database_name='{{ database_name }}' --required, 
@schema_name='{{ schema_name }}' --required, 
@name='{{ name }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@asyncExec={{ asyncExec }}
;

rename

Changes the name of the notebook to new name. The new identifier must be unique for the schema.

EXEC snowflake.apps.notebooks.rename 
@database_name='{{ database_name }}' --required, 
@schema_name='{{ schema_name }}' --required, 
@name='{{ name }}' --required, 
@targetName='{{ targetName }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@ifExists={{ ifExists }}, 
@targetDatabase='{{ targetDatabase }}', 
@targetSchema='{{ targetSchema }}'
;

add_live_version

Adds a LIVE version to the notebook

EXEC snowflake.apps.notebooks.add_live_version 
@database_name='{{ database_name }}' --required, 
@schema_name='{{ schema_name }}' --required, 
@name='{{ name }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@fromLast={{ fromLast }}, 
@comment='{{ comment }}'
;

commit

If a Git connection is set up for the notebook, commits the LIVE version of the notebook to the Git repository

EXEC snowflake.apps.notebooks.commit 
@database_name='{{ database_name }}' --required, 
@schema_name='{{ schema_name }}' --required, 
@name='{{ name }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@version='{{ version }}', 
@comment='{{ comment }}'
;