snowflake.core.account.AccountCollection

class snowflake.core.account.AccountCollection(root: Root)

Bases: AccountCollectionBase

Represents the collection operations of the Snowflake Account resource.

With this collection, you can create, iterate through, and search for an account that you have access to in the current context.

Attributes

root

The Root object this collection belongs to.

Methods

create(account: AccountModel) AccountResource

Create an account in Snowflake.

Parameters:

account (Account) – The Account object, together with the Account’s properties: name, admin_name, email, edition; admin_password, first_name, last_name, must_change_password, region_group, region, comment, polaris are optional.

create_async(account: AccountModel) PollingOperation[AccountResource]

An asynchronous version of create().

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

items() ItemsView[str, T]
iter(*, like: str | None = None, limit: int | None = None, history: bool | None = None) Iterator[AccountModel]

Iterate through Account objects in Snowflake, filtering on any optional like pattern.

Parameters:
  • like (str, optional) – A case-insensitive string functioning as a filter, with support for SQL wildcard characters (% and _).

  • limit (int, optional) – Limit of the maximum number of rows returned by iter(). The default is None, which behaves equivalently to show_limit=10000. This value must be between 1 and 10000.

  • history (bool, optional) – If True, includes dropped accounts that have not yet been deleted. The default is None, which behaves equivalently to False.

iter_async(*, like: str | None = None, limit: int | None = None, history: bool | None = None) PollingOperation[Iterator[AccountModel]]

An asynchronous version of iter().

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

keys() KeysView[str]
update_reference(old_name: str, new_name: str, resource: T) None

Update the collection with a new item.

values() ValuesView[T]