snowflake.core.streamlit.StreamlitResource¶

class snowflake.core.streamlit.StreamlitResource(name: str, collection_class: StreamlitCollectionBase)¶

Bases: StreamlitResourceBase

Represents a reference to a Snowflake Streamlit.

Attributes

database¶

The DatabaseResource this reference belongs to.

fully_qualified_name¶

Return the fully qualified name of the object this reference points to.

root¶

The Root object this reference belongs to.

Methods

abort() → None¶

Abort live version.

abort_async() → PollingOperation[None]¶

An asynchronous version of abort().

Refer to PollingOperation for more information on asynchronous execution and the return type.

add_live_version(from_last: bool | None = None, add_live_version_streamlit_request: AddLiveVersionStreamlitRequest | None = None) → None¶

Add live version.

Parameters:

  • from_last (bool) – Set the LIVE version to the LAST version of the Streamlit.

  • add_live_version_streamlit_request (AddLiveVersionStreamlitRequest)

add_live_version_async(from_last: bool | None = None, add_live_version_streamlit_request: AddLiveVersionStreamlitRequest | None = None) → PollingOperation[None]¶

An asynchronous version of add_live_version().

Refer to PollingOperation for more information on asynchronous execution and the return type.

add_version(add_version_streamlit_request: AddVersionStreamlitRequest) → None¶

Add version from source.

Parameters:

add_version_streamlit_request (AddVersionStreamlitRequest) – (required)

add_version_async(add_version_streamlit_request: AddVersionStreamlitRequest) → PollingOperation[None]¶

An asynchronous version of add_version().

Refer to PollingOperation for more information on asynchronous execution and the return type.

add_version_from_git(add_version_from_git_streamlit_request: AddVersionFromGitStreamlitRequest) → None¶

Add version from Git.

Parameters:

add_version_from_git_streamlit_request (AddVersionFromGitStreamlitRequest) – (required)

add_version_from_git_async(add_version_from_git_streamlit_request: AddVersionFromGitStreamlitRequest) → PollingOperation[None]¶

An asynchronous version of add_version_from_git().

Refer to PollingOperation for more information on asynchronous execution and the return type.

commit(commit_streamlit_request: CommitStreamlitRequest | None = None) → None¶

Commit live version.

Parameters:

commit_streamlit_request (CommitStreamlitRequest)

commit_async(commit_streamlit_request: CommitStreamlitRequest | None = None) → PollingOperation[None]¶

An asynchronous version of commit().

Refer to PollingOperation for more information on asynchronous execution and the return type.

drop(if_exists: bool | None = None) → None¶

Delete a Streamlit.

Parameters:

if_exists (bool) – 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.

drop_async(if_exists: bool | None = None) → PollingOperation[None]¶

An asynchronous version of drop().

Refer to PollingOperation for more information on asynchronous execution and the return type.

fetch() → Streamlit¶

Fetch a Streamlit.

fetch_async() → PollingOperation[Streamlit]¶

An asynchronous version of fetch().

Refer to PollingOperation for more information on asynchronous execution and the return type.

pull() → None¶

Pull from Git.

pull_async() → PollingOperation[None]¶

An asynchronous version of pull().

Refer to PollingOperation for more information on asynchronous execution and the return type.

push(streamlit_push_options: StreamlitPushOptions) → None¶

Push to Git.

Parameters:

streamlit_push_options (StreamlitPushOptions) – (required)

push_async(streamlit_push_options: StreamlitPushOptions) → PollingOperation[None]¶

An asynchronous version of push().

Refer to PollingOperation for more information on asynchronous execution and the return type.

rename(target_name: str, if_exists: bool | None = None, target_database: str | None = None, target_schema: str | None = None) → None¶

Rename a Streamlit.

Parameters:

  • target_name (str) – Name of the target resource. (required)

  • if_exists (bool) – 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.

  • target_database (str) – Database of the target resource. Defaults to the source’s database

  • target_schema (str) – Schema of the target resource. Defaults to the source’s schema

rename_async(target_name: str, if_exists: bool | None = None, target_database: str | None = None, target_schema: str | None = None) → PollingOperation[None]¶

An asynchronous version of rename().

Refer to PollingOperation for more information on asynchronous execution and the return type.

undrop() → None¶

Undrop a Streamlit.

undrop_async() → PollingOperation[None]¶

An asynchronous version of undrop().

Refer to PollingOperation for more information on asynchronous execution and the return type.

Language: English