Warehouse

Warning

The functions are not fully tested yet. Use with caution. Please report any issues to the GitHub repository.

warehouse_create

warehouse_create(
    workspace_id: str,
    display_name: str,
    description: str = None,
    await_lro: bool = None,
    timeout: int = 60 * 5,
    preview: bool = True,
) -> requests.Response

Create a warehouse.

Parameters:

Name	Type	Description	Default
`workspace_id`	`str`	The id of the workspace to create the warehouse in.	required
`display_name`	`str`	The display name of the warehouse.	required
`description`	`str \| None`	The description of the warehouse.	`None`
`await_lro`	`bool \| None`	Whether to await the long running operation.	`None`
`timeout`	`int`	Timeout for the long running operation (seconds). Defaults to 5 minutes.	`60 * 5`
`preview`	`bool`	Whether to preview the request. You will be asked to confirm the request before it is executed. Defaults to True.	`True`

Returns:

Type	Description
`Response`	The response from the request.

warehouse_get

warehouse_get(
    workspace_id: str,
    warehouse_id: str,
    preview: bool = True,
) -> requests.Response

Get a warehouse.

Parameters:

Name	Type	Description	Default
`workspace_id`	`str`	The id of the workspace to get the warehouse from.	required
`warehouse_id`	`str`	The id of the warehouse to get.	required
`preview`	`bool`	Whether to preview the request. You will be asked to confirm the request before it is executed. Defaults to True.	`True`

Returns:

Type	Description
`Response`	The response from the request.

warehouse_list

warehouse_list(
    workspace_id: str,
    continuation_token: str = None,
    preview: bool = True,
) -> requests.Response

List warehouses for a workspace.

Parameters:

Name	Type	Description	Default
`workspace_id`	`str`	The id of the workspace to list warehouses for.	required
`continuation_token`	`str \| None`	A token for retrieving the next page of results.	`None`
`preview`	`bool`	Whether to preview the request. You will be asked to confirm the request before it is executed. Defaults to True.	`True`

Returns:

Type	Description
`Response`	The response from the request.

warehouse_update

warehouse_update(
    workspace_id: str,
    display_name: str = None,
    description: str = None,
    preview: bool = True,
) -> requests.Response

Update a warehouse.

Parameters:

Name	Type	Description	Default
`workspace_id`	`str`	The id of the workspace to update the warehouse in.	required
`display_name`	`str \| None`	The display name of the warehouse.	`None`
`description`	`str \| None`	The description of the warehouse.	`None`
`preview`	`bool`	Whether to preview the request. You will be asked to confirm the request before it is executed. Defaults to True.	`True`

Returns:

Type	Description
`Response`	The response from the request.

warehouse_delete

warehouse_delete(
    workspace_id: str,
    warehouse_id: str,
    preview: bool = True,
) -> requests.Response

Delete a warehouse.

Parameters:

Name	Type	Description	Default
`workspace_id`	`str`	The id of the workspace to delete the warehouse from.	required
`warehouse_id`	`str`	The id of the warehouse to delete.	required
`preview`	`bool`	Whether to preview the request. You will be asked to confirm the request before it is executed. Defaults to True.	`True`

Returns:

Type	Description
`Response`	The response from the request.