snowflake.core.account.AccountResource | Snowflake Documentation (original) (raw)

class snowflake.core.account.AccountResource(name: str, collection: AccountCollection)¶

Bases: ObjectReferenceMixin[AccountCollection]

Represents a reference to a Snowflake account.

With this account reference, you can fetch information about accounts, as well as perform certain actions on them.

Attributes

root¶

The Root object this reference belongs to.

Methods

drop(grace_period_in_days: int, if_exists: bool | None = None) → None¶

Drop this account.

Parameters:

• grace_period_in_days (int) – Specifies the number of days during which the account can be restored.
• if_exists (bool , optional) – Check the existence of this account before dropping it. Default is None, which is equivalent to False.

Examples

Deleting an account using its reference:

account_reference.drop()

Deleting an account using its reference if it exists:

account_reference.drop(if_exists=True)

drop_async(grace_period_in_days: int, 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.

undrop() → None¶

Undrop this account.

Examples

Undropping an account using its reference:

account_reference.undrop()

undrop_async() → PollingOperation[None]¶

An asynchronous version of undrop().

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