snowflake.core.warehouse.WarehouseResource¶

class snowflake.core.warehouse.WarehouseResource(name: str, collection: WarehouseCollection)¶

Bases: ObjectReferenceMixin[WarehouseCollection]

Represents a reference to a Snowflake warehouse.

With this warehouse reference, you can create, update, and fetch information about warehouses, as well as perform certain actions on them.

Attributes

root¶

Methods

abort_all_queries() → None¶

Abort all queries running or queueing on this warehouse.

Examples

Using a warehouse reference to abort all queries:

>>> warehouse = warehouse_reference.abort_all_queries()

create_or_alter(warehouse: WarehouseModel) → None¶

Create a warehouse in Snowflake or alter one if it already exists.

Parameters:: warehouse (Warehouse) – An instance of Warehouse.

Examples

Creating or updating a warehouse in Snowflake:

>>> warehouse_parameters = Warehouse(
...     name="your-warehouse-name",
...     warehouse_size="SMALL",
...     auto_suspend=500,
...)

# Using a WarehouseCollection to create or update a warehouse in Snowflake: >>> root.warehouses[“your-warehouse-name”].create_or_alter(warehouse_parameters)

create_or_update(warehouse: WarehouseModel) → None¶: The create_or_update method is deprecated; use create_or_alter instead.

delete() → None¶: The delete method is deprecated; use drop instead.

drop() → None¶

Drop this warehouse.

Examples

Deleting a warehouse using its reference:

>>> warehouse_reference.drop()

fetch() → WarehouseModel¶

Fetch the details of a warehouse.

Examples

Fetching a warehouse using its reference:

>>> warehouse = warehouse_reference.fetch()

# Accessing information of the warehouse with warehouse instance. >>> print(warehouse.name, warehouse.warehouse_size)

rename(new_name: str) → None¶

Rename this warehouse.

This function will ignore other parameters in warehouse instance; use create_or_update() to update parameters.

Parameters:: new_name (Warehouse) – An instance of Warehouse.

Examples

Using a warehouse reference to rename a warehouse in Snowflake:

>>> new_warehouse = Warehouse(
...     name="new_warehouse_name"
...)
>>> warehouse = warehouse_reference.rename(new_warehouse)

resume() → None¶

Resume the warehouse.

Examples

Using a warehouse reference to resume a warehouse:

>>> warehouse_reference.resume()

suspend() → None¶

Suspend the warehouse.

Examples

Using a warehouse reference to suspend a warehouse:

>>> warehouse_reference.suspend()